diff --git a/_plotly_utils/basevalidators.py b/_plotly_utils/basevalidators.py index bee94de805..f36aa5c5af 100644 --- a/_plotly_utils/basevalidators.py +++ b/_plotly_utils/basevalidators.py @@ -21,6 +21,9 @@ def fullmatch(regex, string, flags=0): regex_string = regex return re.match("(?:" + regex_string + r")\Z", string, flags=flags) +# Constants +INDENT = 8 + # Utility functions # ----------------- @@ -523,7 +526,9 @@ def description(self): enum_regexs = [] for v, regex in zip(self.values, self.val_regexs): if regex is not None: - enum_regexs.append(regex.pattern) + enum_pattern = regex.pattern + escaped_pattern = enum_pattern.replace("[", r"\[").replace("]", r"\]") + enum_regexs.append(escaped_pattern) else: enum_vals.append(v) desc = """\ @@ -535,16 +540,16 @@ def description(self): enum_vals_str = "\n".join( textwrap.wrap( repr(enum_vals), - initial_indent=" " * 12, - subsequent_indent=" " * 12, + initial_indent=" " * INDENT, + subsequent_indent=" " * INDENT, break_on_hyphens=False, ) ) desc = ( desc - + """ - - One of the following enumeration values: + + """\n + - One of the following enumeration values:\n {enum_vals_str}""".format(enum_vals_str=enum_vals_str) ) @@ -552,24 +557,25 @@ def description(self): enum_regexs_str = "\n".join( textwrap.wrap( repr(enum_regexs), - initial_indent=" " * 12, - subsequent_indent=" " * 12, + initial_indent=" " * INDENT, + subsequent_indent=" " * INDENT, break_on_hyphens=False, + break_long_words=False, ) ) desc = ( desc - + """ - - A string that matches one of the following regular expressions: + + """\n + - A string that matches one of the following regular expressions:\n {enum_regexs_str}""".format(enum_regexs_str=enum_regexs_str) ) if self.array_ok: desc = ( desc - + """ - - A tuple, list, or one-dimensional numpy array of the above""" + + """\n + - A tuple, list, or one-dimensional numpy array of the above""" ) return desc @@ -724,14 +730,14 @@ def description(self): desc = ( desc + """\n - - An int or float""" + - An int or float""" ) else: desc = ( desc - + """ - - An int or float in the interval [{min_val}, {max_val}]""".format( + + """\n + - An int or float in the interval [{min_val}, {max_val}]""".format( min_val=self.min_val, max_val=self.max_val ) ) @@ -739,8 +745,8 @@ def description(self): if self.array_ok: desc = ( desc - + """ - - A tuple, list, or one-dimensional numpy array of the above""" + + """\n + - A tuple, list, or one-dimensional numpy array of the above""" ) return desc @@ -853,7 +859,7 @@ def __init__( def description(self): desc = """\ - The '{plotly_name}' property is a integer and may be specified as:""".format( + The '{plotly_name}' property is a integer and may be specified as:\n""".format( plotly_name=self.plotly_name ) @@ -861,12 +867,12 @@ def description(self): desc = ( desc + """ - - An int (or float that will be cast to an int)""" + - An int (or float that will be cast to an int)""" ) else: desc = desc + ( """ - - An int (or float that will be cast to an int) + - An int (or float that will be cast to an int) in the interval [{min_val}, {max_val}]""".format( min_val=self.min_val, max_val=self.max_val ) @@ -1007,44 +1013,44 @@ def description(self): if self.no_blank: desc = ( desc - + """ - - A non-empty string""" + + """\n + - A non-empty string""" ) elif self.values: valid_str = "\n".join( textwrap.wrap( repr(self.values), - initial_indent=" " * 12, - subsequent_indent=" " * 12, + initial_indent=" " * INDENT, + subsequent_indent=" " * INDENT, break_on_hyphens=False, ) ) desc = ( desc - + """ - - One of the following strings: + + """\n + - One of the following strings: {valid_str}""".format(valid_str=valid_str) ) else: desc = ( desc - + """ - - A string""" + + """\n + - A string""" ) if not self.strict: desc = ( desc - + """ - - A number that will be converted to a string""" + + """\n + - A number that will be converted to a string""" ) if self.array_ok: desc = ( desc - + """ - - A tuple, list, or one-dimensional numpy array of the above""" + + """\n + - A tuple, list, or one-dimensional numpy array of the above""" ) return desc @@ -1311,11 +1317,12 @@ def numbers_allowed(self): def description(self): valid_color_description = """\ The '{plotly_name}' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list""".format( + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list""".format( plotly_name=self.plotly_name ) @@ -1323,15 +1330,15 @@ def description(self): valid_color_description = ( valid_color_description + """ - - A number that will be interpreted as a color - according to {colorscale_path}""".format(colorscale_path=self.colorscale_path) - ) + - A number that will be interpreted as a color according to {colorscale_path}""".format( + colorscale_path=self.colorscale_path) + ) if self.array_ok: valid_color_description = ( valid_color_description + """ - - A list or array of any of the above""" + - A list or array of any of the above""" ) return valid_color_description @@ -1553,8 +1560,8 @@ def description(self): colorscales_str = "\n".join( textwrap.wrap( repr(sorted(list(self.named_colorscales))), - initial_indent=" " * 12, - subsequent_indent=" " * 13, + initial_indent=" " * INDENT, + subsequent_indent=" " * INDENT, break_on_hyphens=False, width=80, ) @@ -1562,17 +1569,17 @@ def description(self): desc = """\ The '{plotly_name}' property is a colorscale and may be - specified as: - - A list of colors that will be spaced evenly to create the colorscale. + specified as:\n + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - 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: -{colorscales_str}. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales:\n +{colorscales_str}.\n + Appending '_r' to a named colorscale reverses it. """.format(plotly_name=self.plotly_name, colorscales_str=colorscales_str) return desc @@ -1810,13 +1817,13 @@ def description(self): desc = ( """\ The '{plotly_name}' property is a flaglist and may be specified - as a string containing:""" + as a string containing:\n""" ).format(plotly_name=self.plotly_name) # Flags desc = desc + ( """ - - Any combination of {flags} joined with '+' characters + - Any combination of {flags} joined with '+' characters (e.g. '{eg_flag}')""" ).format(flags=self.flags, eg_flag="+".join(self.flags[:2])) @@ -1831,7 +1838,7 @@ def description(self): desc = ( desc + """ - - A list or array of the above""" + - A list or array of the above""" ) return desc @@ -1989,10 +1996,12 @@ def description(self): for i, item_validator in enumerate(self.item_validators): el_desc = item_validator.description().strip() + lines = el_desc.splitlines() + el_desc_indented = '\n'.join([lines[0]] + [' ' + line for line in lines[1:]]) desc = ( desc + """\n - ({i}) {el_desc}""".format(i=i, el_desc=el_desc) + ({i}) {el_desc_indented}""".format(i=i, el_desc_indented=el_desc_indented) ) # ### Case 2 ### @@ -2005,7 +2014,7 @@ def description(self): for i, item_validator in enumerate(self.item_validators): # Update name for 2d orig_name = item_validator.plotly_name - item_validator.plotly_name = "{name}\\[i\\]\\[{i}\\]".format( + item_validator.plotly_name = "{name}\\\\[i\\\\]\\\\[{i}\\\\]".format( name=self.plotly_name, i=i ) @@ -2027,21 +2036,28 @@ def description(self): el_desc = item_validator.description().strip() - desc += """ - * a list of elements where: - {el_desc} -""".format(el_desc=el_desc) + # Adds an indentation of 4 spaces, especially when el_desc + # is a fully auto-generated docstring with nested lists. + lines = el_desc.splitlines() + el_desc_indented = '\n'.join([lines[0]] + [' ' + line for line in lines[1:]]) + + desc += """\n + * a list of elements where:\n + {el_desc_indented} +""".format(el_desc_indented=el_desc_indented) if self.dimensions in ("1-2", 2): - item_validator.plotly_name = "{name}\\[i\\]\\[j\\]".format( + item_validator.plotly_name = "{name}\\\\[i\\\\]\\\\[j\\\\]".format( name=self.plotly_name ) el_desc = item_validator.description().strip() + lines = el_desc.splitlines() + el_desc_indented = '\n'.join([lines[0]] + [' ' + line for line in lines[1:]]) desc += """\n * a 2D list where:\n - {el_desc} -""".format(el_desc=el_desc) + {el_desc_indented} +""".format(el_desc_indented=el_desc_indented) item_validator.plotly_name = orig_name @@ -2272,8 +2288,8 @@ def description(self): enum_vals_str = "\n".join( textwrap.wrap( repr(enum_vals), - initial_indent=" " * 12, - subsequent_indent=" " * 12, + initial_indent=" " * INDENT, + subsequent_indent=" " * INDENT, break_on_hyphens=False, width=80, ) @@ -2281,16 +2297,16 @@ def description(self): desc = ( desc - + """ - - One of the following dash styles: + + """\n + - One of the following dash styles:\n {enum_vals_str}""".format(enum_vals_str=enum_vals_str) ) desc = ( desc - + """ - - 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.) + + """\n + - A string containing a dash length list in pixels or percentages\n + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) """ ) return desc @@ -2404,10 +2420,9 @@ def description(self): desc = ( """\ The '{plotly_name}' property is an instance of {class_str} - that may be specified as: - - An instance of :class:`{module_str}.{class_str}` - - A dict of string/value properties that will be passed - to the {class_str} constructor""" + that may be specified as:\n + - An instance of :class:`{module_str}.{class_str}` + - A dict of string/value properties that will be passed to the {class_str} constructor""" ).format( plotly_name=self.plotly_name, class_str=self.data_class_str, @@ -2476,9 +2491,9 @@ def description(self): desc = ( """\ The '{plotly_name}' property is a tuple of instances of - {class_str} that may be specified as: - - A list or tuple of instances of {module_str}.{class_str} - - A list or tuple of dicts of string/value properties that + {class_str} that may be specified as:\n + - A list or tuple of instances of {module_str}.{class_str} + - A list or tuple of dicts of string/value properties that will be passed to the {class_str} constructor""" ).format( plotly_name=self.plotly_name, @@ -2559,17 +2574,17 @@ def description(self): desc = ( """\ The '{plotly_name}' property is a tuple of trace instances - that may be specified as: - - A list or tuple of trace instances + that may be specified as:\n + - A list or tuple of trace instances (e.g. [Scatter(...), Bar(...)]) - - A single trace instance + - A single trace instance (e.g. Scatter(...), Bar(...), etc.) - - A list or tuple of dicts of string/value properties where: - - The 'type' property specifies the trace type + - A list or tuple of dicts of string/value properties where: + - The 'type' property specifies the trace type\n {trace_types} - - All remaining properties are passed to the constructor of - the specified trace type + - All remaining properties are passed to the constructor of + the specified trace type (e.g. [{{'type': 'scatter', ...}}, {{'type': 'bar, ...}}])""" ).format(plotly_name=self.plotly_name, trace_types=trace_types_wrapped) diff --git a/bin/codegen/__init__.py b/bin/codegen/__init__.py index 6e2368fa09..8d1e187ab5 100644 --- a/bin/codegen/__init__.py +++ b/bin/codegen/__init__.py @@ -1,5 +1,6 @@ import json import os +from pathlib import Path import shutil import sys @@ -27,6 +28,11 @@ ) +PROJECT_ROOT = Path(__file__).parent.parent.parent +PLOT_SCHEMA_RELATIVE = Path("resources") / "plot-schema.json" +PLOT_SCHEMA = PROJECT_ROOT / PLOT_SCHEMA_RELATIVE + + # Import notes # ------------ # Nothing from the plotly/ package should be imported during code @@ -94,7 +100,7 @@ def make_paths(codedir): return validators_dir, graph_objects_dir, graph_objs_path -def perform_codegen(codedir, noformat=False): +def perform_codegen(codedir, noformat=False, schema=PLOT_SCHEMA): """Generate code.""" # Get paths @@ -108,8 +114,7 @@ def perform_codegen(codedir, noformat=False): # Load plotly schema project_root = codedir.parent - plot_schema_path = project_root / "resources" / "plot-schema.json" - with open(plot_schema_path, "r") as f: + with open(schema, "r") as f: plotly_schema = json.load(f) # Preprocess Schema @@ -284,7 +289,9 @@ def __getattr__(import_name): init_extra = optional_figure_widget_import else: init_extra = "" - write_init_py(graph_objects_pkg, path_parts, rel_modules, rel_classes, init_extra) + write_init_py( + graph_objects_pkg, path_parts, rel_modules, rel_classes, init_extra + ) # Output graph_objs.py alias graph_objs_rel_classes = [ @@ -303,7 +310,7 @@ def __getattr__(import_name): ) graph_objs_path = codedir / "graph_objs" graph_objs_path.mkdir(parents=True, exist_ok=True) - graph_objs_path /= "__init__.py" + graph_objs_path /= "__init__.py" with open(graph_objs_path, "wt") as f: f.write("# ruff: noqa: F401\n") f.write(graph_objs_init_source) diff --git a/bin/generate_code.py b/bin/generate_code.py index 94fef3991c..0a5ccc3a2a 100644 --- a/bin/generate_code.py +++ b/bin/generate_code.py @@ -11,15 +11,21 @@ def main(): args = parse_args() codedir = utils.select_code_directory(args) - utils.perform_codegen(codedir, noformat=args.noformat) + utils.perform_codegen(codedir, noformat=args.noformat, schema=args.schema) def parse_args(): """Parse command-line arguments.""" parser = argparse.ArgumentParser() - parser.add_argument("--noformat", action="store_true", help="prevent reformatting") parser.add_argument("--codedir", type=Path, help="code directory") + parser.add_argument("--noformat", action="store_true", help="prevent reformatting") + parser.add_argument( + "--schema", + type=Path, + default=utils.PLOT_SCHEMA, + help=f"schema file (default {utils.PLOT_SCHEMA})", + ) return parser.parse_args() diff --git a/bin/utils.py b/bin/utils.py index 0dd39a4ddf..ae92449ab5 100644 --- a/bin/utils.py +++ b/bin/utils.py @@ -3,7 +3,6 @@ import logging import json import os -from pathlib import Path import platform import requests import shutil @@ -11,14 +10,15 @@ import sys import time -from codegen import perform_codegen - +from codegen import ( + perform_codegen, + PROJECT_ROOT, + PLOT_SCHEMA, +) LOGGER = logging.getLogger(__name__) -PROJECT_ROOT = Path(__file__).parent.parent NODE_ROOT = PROJECT_ROOT / "js" NODE_MODULES = NODE_ROOT / "node_modules" -PLOT_SCHEMA = PROJECT_ROOT / "resources" / "plot-schema.json" WIDGET_TARGETS = [PROJECT_ROOT / "plotly" / "package_data" / "widgetbundle.js"] NPM_PATH = os.pathsep.join( [ diff --git a/plotly/basedatatypes.py b/plotly/basedatatypes.py index 5e6b819105..e67f7a0c05 100644 --- a/plotly/basedatatypes.py +++ b/plotly/basedatatypes.py @@ -871,7 +871,7 @@ def update(self, dict1=None, overwrite=False, **kwargs): ---------- dict1 : dict Dictionary of properties to be updated - overwrite: bool + overwrite : bool If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation. @@ -938,9 +938,9 @@ def pop(self, key, *args): Parameters ---------- - key: str + key : str Property name - dflt + dflt: The default value to return if key was not found in figure Returns @@ -1119,7 +1119,7 @@ def select_traces(self, selector=None, row=None, col=None, secondary_y=None): Parameters ---------- - selector: dict, function, int, str or None (default None) + selector : dict, function, int, str or None (default None) Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary's keys, with values that exactly match @@ -1130,12 +1130,12 @@ def select_traces(self, selector=None, row=None, col=None, secondary_y=None): will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S). - row, col: int or None (default None) + row, col : int or None (default None) Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected. - secondary_y: boolean or None (default None) + secondary_y : boolean or None (default None) * If True, only select traces associated with the secondary y-axis of the subplot. * If False, only select traces associated with the primary @@ -1281,7 +1281,7 @@ def for_each_trace(self, fn, selector=None, row=None, col=None, secondary_y=None ---------- fn: Function that inputs a single trace object. - selector: dict, function, int, str or None (default None) + selector : dict, function, int, str or None (default None) Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary's keys, with values that exactly match @@ -1292,12 +1292,12 @@ def for_each_trace(self, fn, selector=None, row=None, col=None, secondary_y=None will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S). - row, col: int or None (default None) + row, col : int or None (default None) Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected. - secondary_y: boolean or None (default None) + secondary_y : boolean or None (default None) * If True, only select traces associated with the secondary y-axis of the subplot. * If False, only select traces associated with the primary @@ -1337,10 +1337,10 @@ def update_traces( Parameters ---------- - patch: dict or None (default None) + patch : dict or None (default None) Dictionary of property updates to be applied to all traces that satisfy the selection criteria. - selector: dict, function, int, str or None (default None) + selector : dict, function, int, str or None (default None) Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary's keys, with values that exactly match @@ -1351,12 +1351,12 @@ def update_traces( will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S). - row, col: int or None (default None) + row, col : int or None (default None) Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected. - secondary_y: boolean or None (default None) + secondary_y : boolean or None (default None) * If True, only select traces associated with the secondary y-axis of the subplot. * If False, only select traces associated with the primary @@ -1368,14 +1368,14 @@ def update_traces( created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes. - overwrite: bool + overwrite : bool If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation. **kwargs Additional property updates to apply to each selected trace. If - a property is specified in both patch and in **kwargs then the - one in **kwargs takes precedence. + a property is specified in both patch and in \*\*kwargs then the + one in \*\*kwargs takes precedence. Returns ------- @@ -1400,7 +1400,7 @@ def update_layout(self, dict1=None, overwrite=False, **kwargs): ---------- dict1 : dict Dictionary of properties to be updated - overwrite: bool + overwrite : bool If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation. @@ -1664,9 +1664,11 @@ def plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs): example, the following command would be used to update the 'x' property of the first trace to the list [1, 2, 3] + ```python >>> import plotly.graph_objs as go >>> fig = go.Figure(go.Scatter(x=[2, 4, 6])) >>> fig.plotly_restyle({'x': [[1, 2, 3]]}, 0) + ``` trace_indexes : int or list of int Trace index, or list of trace indexes, that the restyle operation @@ -2030,7 +2032,7 @@ def add_trace( Parameters ---------- trace : BaseTraceType or dict - Either: + Either:\n - An instances of a trace classe from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar) - or a dicts where: @@ -2051,10 +2053,10 @@ def add_trace( added. Only valid if figure was created using `plotly.tools.make_subplots`. If 'all', addresses all columns in the specified row(s). - secondary_y: boolean or None (default None) + secondary_y : boolean or None (default None) If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the - following conditions are satisfied: + following conditions are satisfied:\n * The figure was created using `plotly.subplots.make_subplots`. * The row and col arguments are not None * The subplot at the specified row and col has type xy @@ -2168,11 +2170,11 @@ def add_traces( If a single integer is passed, all traces will be added to column number - secondary_ys: None or list[boolean] (default None) + secondary_ys : None or list[boolean] (default None) List of secondary_y booleans for traces to be added. See the docstring for `add_trace` for more info. - exclude_empty_subplots: boolean + exclude_empty_subplots : boolean If True, the trace will not be added to subplots that don't already have traces. @@ -2306,9 +2308,9 @@ def append_trace(self, trace, row, col): ---------- trace The data trace to be bound - row: int + row : int Subplot row index (see Figure.print_grid) - col: int + col : int Subplot column index (see Figure.print_grid) Examples @@ -2409,11 +2411,11 @@ def get_subplot(self, row, col, secondary_y=False): Parameters ---------- - row: int + row : int 1-based index of subplot row - col: int + col : int 1-based index of subplot column - secondary_y: bool + secondary_y : bool If True, select the subplot that consists of the x-axis and the secondary y-axis at the specified row/col. Only valid if the subplot at row/col is an 2D cartesian subplot that was created @@ -3134,43 +3136,43 @@ def batch_animate(self, duration=500, easing="cubic-in-out"): If equal to zero, updates are synchronous. easing : string The easing function used for the transition. - One of: - - linear - - quad - - cubic - - sin - - exp - - circle - - elastic - - back - - bounce - - linear-in - - quad-in - - cubic-in - - sin-in - - exp-in - - circle-in - - elastic-in - - back-in - - bounce-in - - linear-out - - quad-out - - cubic-out - - sin-out - - exp-out - - circle-out - - elastic-out - - back-out - - bounce-out - - linear-in-out - - quad-in-out - - cubic-in-out - - sin-in-out - - exp-in-out - - circle-in-out - - elastic-in-out - - back-in-out - - bounce-in-out + One of:\n + - linear + - quad + - cubic + - sin + - exp + - circle + - elastic + - back + - bounce + - linear-in + - quad-in + - cubic-in + - sin-in + - exp-in + - circle-in + - elastic-in + - back-in + - bounce-in + - linear-out + - quad-out + - cubic-out + - sin-out + - exp-out + - circle-out + - elastic-out + - back-out + - bounce-out + - linear-in-out + - quad-in-out + - cubic-in-out + - sin-in-out + - exp-in-out + - circle-in-out + - elastic-in-out + - back-in-out + - bounce-in-out Examples -------- @@ -3390,24 +3392,24 @@ def show(self, *args, **kwargs): Parameters ---------- - renderer: str or None (default None) + renderer : str or None (default None) A string containing the names of one or more registered renderers (separated by '+' characters) or None. If None, then the default renderers specified in plotly.io.renderers.default are used. - validate: bool (default True) + validate : bool (default True) True if the figure should be validated before being shown, False otherwise. - width: int or float + width : int or float An integer or float that determines the number of pixels wide the plot is. The default is set in plotly.js. - height: int or float + height : int or float An integer or float specifying the height of the plot in pixels. The default is set in plotly.js. - config: dict + config : dict A dict of parameters to configure the figure. The defaults are set in plotly.js. @@ -3425,19 +3427,19 @@ def to_json(self, *args, **kwargs): Parameters ---------- - validate: bool (default True) + validate : bool (default True) True if the figure should be validated before being converted to JSON, False otherwise. - pretty: bool (default False) + pretty : bool (default False) True if JSON representation should be pretty-printed, False if representation should be as compact as possible. - remove_uids: bool (default True) + remove_uids : bool (default True) True if trace UIDs should be omitted from the JSON representation - engine: str (default None) - The JSON encoding engine to use. One of: + engine : str (default None) + The JSON encoding engine to use. One of:\n - "json" for an encoder based on the built-in Python json module - "orjson" for a fast encoder the requires the orjson package If not specified, the default encoder is set to the current value of @@ -3462,13 +3464,10 @@ def full_figure_for_development(self, warn=True, as_dict=False): Parameters ---------- - fig: - Figure object or dict representing a figure - - warn: bool + warn : bool If False, suppress warnings about not using this in production. - as_dict: bool + as_dict : bool If True, output is a dict with some keys that go.Figure can't parse. If False, output is a go.Figure with unparseable keys skipped. @@ -3488,19 +3487,19 @@ def write_json(self, *args, **kwargs): Parameters ---------- - file: str or writeable + file : str or writeable A string representing a local file path or a writeable object (e.g. an open file descriptor) - pretty: bool (default False) + pretty : bool (default False) True if JSON representation should be pretty-printed, False if representation should be as compact as possible. - remove_uids: bool (default True) + remove_uids : bool (default True) True if trace UIDs should be omitted from the JSON representation - engine: str (default None) - The JSON encoding engine to use. One of: + engine : str (default None) + The JSON encoding engine to use. One of:\n - "json" for an encoder based on the built-in Python json module - "orjson" for a fast encoder the requires the orjson package If not specified, the default encoder is set to the current value of @@ -3520,13 +3519,13 @@ def to_html(self, *args, **kwargs): Parameters ---------- - config: dict or None (default None) + config : dict or None (default None) Plotly.js figure config options - auto_play: bool (default=True) + auto_play : bool (default=True) Whether to automatically start the animation sequence on page load if the figure contains frames. Has no effect if the figure does not contain frames. - include_plotlyjs: bool or string (default True) + include_plotlyjs : bool or string (default True) Specifies how the plotly.js library is included/loaded in the output div string. @@ -3552,7 +3551,7 @@ def to_html(self, *args, **kwargs): useful when the resulting div string will be placed inside an HTML document that already loads plotly.js. This option is not advised when full_html=True as it will result in a non-functional html file. - include_mathjax: bool or string (default False) + include_mathjax : bool or string (default False) Specifies how the MathJax.js library is included in the output html div string. MathJax is required in order to display labels with LaTeX typesetting. @@ -3568,31 +3567,31 @@ def to_html(self, *args, **kwargs): If a string that ends in '.js', a script tag is included that references the specified path. This approach can be used to point the resulting HTML div string to an alternative CDN. - post_script: str or list or None (default None) + post_script : str or list or None (default None) JavaScript snippet(s) to be included in the resulting div just after plot creation. The string(s) may include '{plot_id}' placeholders that will then be replaced by the `id` of the div element that the plotly.js figure is associated with. One application for this script is to install custom plotly.js event handlers. - full_html: bool (default True) + full_html : bool (default True) If True, produce a string containing a complete HTML document starting with an tag. If False, produce a string containing a single
element. - animation_opts: dict or None (default None) + animation_opts : dict or None (default None) dict of custom animation parameters to be passed to the function Plotly.animate in Plotly.js. See https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js for available options. Has no effect if the figure does not contain frames, or auto_play is False. - default_width, default_height: number or str (default '100%') + default_width, default_height : number or str (default '100%') The default figure width/height to use if the provided figure does not specify its own layout.width/layout.height property. May be specified in pixels as an integer (e.g. 500), or as a css width style string (e.g. '500px', '100%'). - validate: bool (default True) + validate : bool (default True) True if the figure should be validated before being converted to JSON, False otherwise. - div_id: str (default None) + div_id : str (default None) If provided, this is the value of the id attribute of the div tag. If None, the id attribute is a UUID. @@ -3611,16 +3610,16 @@ def write_html(self, *args, **kwargs): Parameters ---------- - file: str or writeable + file : str or writeable A string representing a local file path or a writeable object (e.g. a pathlib.Path object or an open file descriptor) - config: dict or None (default None) + config : dict or None (default None) Plotly.js figure config options - auto_play: bool (default=True) + auto_play : bool (default=True) Whether to automatically start the animation sequence on page load if the figure contains frames. Has no effect if the figure does not contain frames. - include_plotlyjs: bool or string (default True) + include_plotlyjs : bool or string (default True) Specifies how the plotly.js library is included/loaded in the output div string. @@ -3656,7 +3655,7 @@ def write_html(self, *args, **kwargs): document that already loads plotly.js. This option is not advised when full_html=True as it will result in a non-functional html file. - include_mathjax: bool or string (default False) + include_mathjax : bool or string (default False) Specifies how the MathJax.js library is included in the output html div string. MathJax is required in order to display labels with LaTeX typesetting. @@ -3672,34 +3671,34 @@ def write_html(self, *args, **kwargs): If a string that ends in '.js', a script tag is included that references the specified path. This approach can be used to point the resulting HTML div string to an alternative CDN. - post_script: str or list or None (default None) + post_script : str or list or None (default None) JavaScript snippet(s) to be included in the resulting div just after plot creation. The string(s) may include '{plot_id}' placeholders that will then be replaced by the `id` of the div element that the plotly.js figure is associated with. One application for this script is to install custom plotly.js event handlers. - full_html: bool (default True) + full_html : bool (default True) If True, produce a string containing a complete HTML document starting with an tag. If False, produce a string containing a single
element. - animation_opts: dict or None (default None) + animation_opts : dict or None (default None) dict of custom animation parameters to be passed to the function Plotly.animate in Plotly.js. See https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js for available options. Has no effect if the figure does not contain frames, or auto_play is False. - default_width, default_height: number or str (default '100%') + default_width, default_height : number or str (default '100%') The default figure width/height to use if the provided figure does not specify its own layout.width/layout.height property. May be specified in pixels as an integer (e.g. 500), or as a css width style string (e.g. '500px', '100%'). - validate: bool (default True) + validate : bool (default True) True if the figure should be validated before being converted to JSON, False otherwise. - auto_open: bool (default True) + auto_open : bool (default True) If True, open the saved file in a web browser after saving. This argument only applies if `full_html` is True. - div_id: str (default None) + div_id : str (default None) If provided, this is the value of the id attribute of the div tag. If None, the id attribute is a UUID. @@ -3717,54 +3716,54 @@ def to_image(self, *args, **kwargs): Parameters ---------- - format: str or None - The desired image format. One of - - 'png' - - 'jpg' or 'jpeg' - - 'webp' - - 'svg' - - 'pdf' - - 'eps' (deprecated) (Requires the poppler library to be installed) - - If not specified, will default to: - - `plotly.io.defaults.default_format` if engine is "kaleido" - - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated) - - width: int or None + format : str or None + The desired image format. One of:\n + - 'png' + - 'jpg' or 'jpeg' + - 'webp' + - 'svg' + - 'pdf' + - 'eps' (deprecated) (Requires the poppler library to be installed) + + If not specified, will default to:\n + - `plotly.io.defaults.default_format` if engine is "kaleido" + - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated) + + width : int or None The width of the exported image in layout pixels. If the `scale` property is 1.0, this will also be the width of the exported image in physical pixels. - If not specified, will default to: - - `plotly.io.defaults.default_width` if engine is "kaleido" - - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated) + If not specified, will default to:\n + - `plotly.io.defaults.default_width` if engine is "kaleido" + - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated) - height: int or None + height : int or None The height of the exported image in layout pixels. If the `scale` property is 1.0, this will also be the height of the exported image in physical pixels. - If not specified, will default to: - - `plotly.io.defaults.default_height` if engine is "kaleido" - - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated) + If not specified, will default to:\n + - `plotly.io.defaults.default_height` if engine is "kaleido" + - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated) - scale: int or float or None + scale : int or float or None The scale factor to use when exporting the figure. A scale factor larger than 1.0 will increase the image resolution with respect to the figure's layout pixel dimensions. Whereas as scale factor of less than 1.0 will decrease the image resolution. - If not specified, will default to: - - `plotly.io.defaults.default_scale` if engine is "kaliedo" - - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated) + If not specified, will default to:\n + - `plotly.io.defaults.default_scale` if engine is "kaliedo" + - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated) - validate: bool + validate : bool True if the figure should be validated before being converted to an image, False otherwise. - engine (deprecated): str + engine (deprecated) : str Image export engine to use. This parameter is deprecated and Orca engine support will be - dropped in the next major Plotly version. Until then, the following values are supported: + dropped in the next major Plotly version. Until then, the following values are supported:\n - "kaleido": Use Kaleido for image export - "orca": Use Orca for image export - "auto" (default): Use Kaleido if installed, otherwise use Orca @@ -3807,60 +3806,60 @@ def write_image(self, *args, **kwargs): Parameters ---------- - file: str or writeable + file : str or writeable A string representing a local file path or a writeable object (e.g. a pathlib.Path object or an open file descriptor) - format: str or None - The desired image format. One of - - 'png' - - 'jpg' or 'jpeg' - - 'webp' - - 'svg' - - 'pdf' - - 'eps' (deprecated) (Requires the poppler library to be installed) + format : str or None + The desired image format. One of:\n + - 'png' + - 'jpg' or 'jpeg' + - 'webp' + - 'svg' + - 'pdf' + - 'eps' (deprecated) (Requires the poppler library to be installed) If not specified and `file` is a string then this will default to the file extension. If not specified and `file` is not a string then this - will default to: - - `plotly.io.defaults.default_format` if engine is "kaleido" - - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated) + will default to:\n + - `plotly.io.defaults.default_format` if engine is "kaleido" + - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated) - width: int or None + width : int or None The width of the exported image in layout pixels. If the `scale` property is 1.0, this will also be the width of the exported image in physical pixels. - If not specified, will default to: - - `plotly.io.defaults.default_width` if engine is "kaleido" - - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated) + If not specified, will default to:\n + - `plotly.io.defaults.default_width` if engine is "kaleido" + - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated) - height: int or None + height : int or None The height of the exported image in layout pixels. If the `scale` property is 1.0, this will also be the height of the exported image in physical pixels. - If not specified, will default to: - - `plotly.io.defaults.default_height` if engine is "kaleido" - - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated) + If not specified, will default to:\n + - `plotly.io.defaults.default_height` if engine is "kaleido" + - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated) - scale: int or float or None + scale : int or float or None The scale factor to use when exporting the figure. A scale factor larger than 1.0 will increase the image resolution with respect to the figure's layout pixel dimensions. Whereas as scale factor of less than 1.0 will decrease the image resolution. - If not specified, will default to: - - `plotly.io.defaults.default_scale` if engine is "kaleido" - - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated) + If not specified, will default to:\n + - `plotly.io.defaults.default_scale` if engine is "kaleido" + - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated) - validate: bool + validate : bool True if the figure should be validated before being converted to an image, False otherwise. - engine (deprecated): str + engine (deprecated) : str Image export engine to use. This parameter is deprecated and Orca engine support will be - dropped in the next major Plotly version. Until then, the following values are supported: + dropped in the next major Plotly version. Until then, the following values are supported:\n - "kaleido": Use Kaleido for image export - "orca": Use Orca for image export - "auto" (default): Use Kaleido if installed, otherwise use Orca @@ -4735,16 +4734,16 @@ def __getitem__(self, prop): Parameters ---------- - prop : str|tuple + prop : str or tuple If prop is the name of a property of this object, then the property is returned. If prop is a nested property path string (e.g. 'foo[1].bar'), - then a nested property is returned (e.g. obj['foo'][1]['bar']) + then a nested property is returned (e.g. obj\\['foo'\\]\\[1\\]\\['bar'\\]) If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested - property is returned (e.g. obj['foo'][1]['bar']). + property is returned (e.g. obj\\['foo'\\]\\[1\\]\\['bar'\\]). Returns ------- @@ -4830,17 +4829,17 @@ def __contains__(self, prop): Parameters ---------- - prop : str|tuple + prop : str or tuple If prop is a simple string (e.g. 'foo'), then return true of the object contains an element named 'foo' If prop is a property path string (e.g. 'foo[0].bar'), then return true if the obejct contains the nested elements for - each entry in the path string (e.g. 'bar' in obj['foo'][0]) + each entry in the path string (e.g. 'bar' in obj\\['foo'\\]\\[0\\]) If prop is a property path tuple (e.g. ('foo', 0, 'bar')), then return true if the object contains the nested elements for - each entry in the path string (e.g. 'bar' in obj['foo'][0]) + each entry in the path string (e.g. 'bar' in obj\\['foo'\\]\\[0\\]) Returns ------- @@ -5177,7 +5176,7 @@ def update(self, dict1=None, overwrite=False, **kwargs): ---------- dict1 : dict Dictionary of properties to be updated - overwrite: bool + overwrite : bool If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation. @@ -5205,7 +5204,7 @@ def pop(self, key, *args): Parameters ---------- - key: str + key : str Property name dflt The default value to return if key was not found in object @@ -5577,12 +5576,11 @@ def on_change(self, callback, *args, **kwargs): is this object. Second through last parameters are the property / subpropery values referenced by args. args : list[str|tuple[int|str]] - List of property references where each reference may be one of: - - 1) A property name string (e.g. 'foo') for direct properties - 2) A property path string (e.g. 'foo[0].bar') for + List of property references where each reference may be one of:\n + - A property name string (e.g. 'foo') for direct properties + - A property path string (e.g. 'foo[0].bar') for subproperties - 3) A property path tuple (e.g. ('foo', 0, 'bar')) for + - A property path tuple (e.g. ('foo', 0, 'bar')) for subproperties append : bool @@ -5668,19 +5666,19 @@ def to_json(self, *args, **kwargs): Parameters ---------- - validate: bool (default True) + validate : bool (default True) True if the object should be validated before being converted to JSON, False otherwise. - pretty: bool (default False) + pretty : bool (default False) True if JSON representation should be pretty-printed, False if representation should be as compact as possible. - remove_uids: bool (default True) + remove_uids : bool (default True) True if trace UIDs should be omitted from the JSON representation - engine: str (default None) - The JSON encoding engine to use. One of: + engine : str (default None) + The JSON encoding engine to use. One of:\n - "json" for an encoder based on the built-in Python json module - "orjson" for a fast encoder the requires the orjson package If not specified, the default encoder is set to the current value of diff --git a/plotly/express/_imshow.py b/plotly/express/_imshow.py index 83dee3e3dc..0f5e88fc4f 100644 --- a/plotly/express/_imshow.py +++ b/plotly/express/_imshow.py @@ -168,11 +168,11 @@ def imshow( The figure height in pixels. aspect : 'equal', 'auto', or None - - 'equal': Ensures an aspect ratio of 1 or pixels (square pixels) - - 'auto': The axes is kept fixed and the aspect ratio of pixels is + - 'equal': Ensures an aspect ratio of 1 or pixels (square pixels) + - 'auto': The axes is kept fixed and the aspect ratio of pixels is adjusted so that the data fit in the axes. In general, this will result in non-square pixels. - - if None, 'equal' is used for numpy arrays and 'auto' for xarrays + - if None, 'equal' is used for numpy arrays and 'auto' for xarrays (which have typically heterogeneous coordinates) contrast_rescaling : 'minmax', 'infer', or None diff --git a/plotly/figure_factory/_ternary_contour.py b/plotly/figure_factory/_ternary_contour.py index 0475c5a96a..85f33ba01e 100644 --- a/plotly/figure_factory/_ternary_contour.py +++ b/plotly/figure_factory/_ternary_contour.py @@ -563,8 +563,7 @@ def create_ternary_contour( superimposed on contours, using the same colorscale. Examples - ======== - + -------- Example 1: ternary contour plot with filled contours >>> import plotly.figure_factory as ff diff --git a/plotly/graph_objects/_bar.py b/plotly/graph_objects/_bar.py index 181cbec44e..d999e05927 100644 --- a/plotly/graph_objects/_bar.py +++ b/plotly/graph_objects/_bar.py @@ -94,8 +94,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -172,8 +174,10 @@ def constraintext(self): 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'] + + - One of the following enumeration values: + + ['inside', 'outside', 'both', 'none'] Returns ------- @@ -232,7 +236,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -251,7 +255,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -268,9 +272,9 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.ErrorX` - - A dict of string/value properties that will be passed - to the ErrorX constructor + + - An instance of :class:`plotly.graph_objects.bar.ErrorX` + - A dict of string/value properties that will be passed to the ErrorX constructor Returns ------- @@ -287,9 +291,9 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.ErrorY` - - A dict of string/value properties that will be passed - to the ErrorY constructor + + - An instance of :class:`plotly.graph_objects.bar.ErrorY` + - A dict of string/value properties that will be passed to the ErrorY constructor Returns ------- @@ -310,10 +314,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -349,9 +354,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.bar.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -393,9 +398,12 @@ def hovertemplate(self): ``. 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -436,9 +444,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -514,8 +525,10 @@ def insidetextanchor(self): `textposition` "inside" mode. The 'insidetextanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['end', 'middle', 'start'] + + - One of the following enumeration values: + + ['end', 'middle', 'start'] Returns ------- @@ -534,9 +547,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.bar.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -579,8 +592,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -597,9 +612,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.bar.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -625,7 +640,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -644,7 +659,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -661,9 +677,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.bar.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -726,8 +742,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -748,8 +766,9 @@ def offset(self): 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 + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -769,8 +788,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -806,7 +827,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -825,8 +847,10 @@ def orientation(self): 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -845,9 +869,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.bar.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -864,9 +888,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.bar.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -924,9 +948,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.bar.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -949,9 +973,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -993,9 +1020,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.bar.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -1020,9 +1047,12 @@ def textposition(self): text appears. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['inside', 'outside', 'auto', 'none'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['inside', 'outside', 'auto', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1090,9 +1120,12 @@ def texttemplate(self): and `label`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1130,8 +1163,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1179,9 +1214,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.bar.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1201,8 +1236,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1220,8 +1257,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1317,11 +1356,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1349,8 +1390,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1410,8 +1453,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1507,11 +1552,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1539,8 +1586,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1600,8 +1649,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1639,7 +1690,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_barpolar.py b/plotly/graph_objects/_barpolar.py index a5b1aacf7b..90972969d7 100644 --- a/plotly/graph_objects/_barpolar.py +++ b/plotly/graph_objects/_barpolar.py @@ -143,7 +143,7 @@ def dr(self): The 'dr' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -164,7 +164,7 @@ def dtheta(self): The 'dtheta' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -185,10 +185,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -224,9 +225,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.barpolar.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -266,9 +267,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -305,9 +309,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -407,8 +414,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -425,9 +434,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.barpolar.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -453,7 +462,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -472,7 +481,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -489,9 +499,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.barpolar.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -554,8 +564,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -575,8 +587,9 @@ def offset(self): 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 + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -612,7 +625,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -684,9 +698,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.barpolar.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -744,9 +758,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.barpolar.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -790,9 +804,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -884,8 +901,10 @@ def thetaunit(self): on "linear" angular axes. The 'thetaunit' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['radians', 'degrees', 'gradians'] + + - One of the following enumeration values: + + ['radians', 'degrees', 'gradians'] Returns ------- @@ -904,8 +923,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -953,9 +974,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.barpolar.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -975,8 +996,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -994,8 +1017,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/_box.py b/plotly/graph_objects/_box.py index 8aabbac18a..6e0cbcfe3d 100644 --- a/plotly/graph_objects/_box.py +++ b/plotly/graph_objects/_box.py @@ -106,8 +106,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -128,8 +130,10 @@ def boxmean(self): Defaults to "sd" when `sd` is set Otherwise defaults to False. The 'boxmean' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'sd', False] + + - One of the following enumeration values: + + [True, 'sd', False] Returns ------- @@ -155,8 +159,10 @@ def boxpoints(self): defaults to "outliers". The 'boxpoints' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'outliers', 'suspectedoutliers', False] + + - One of the following enumeration values: + + ['all', 'outliers', 'suspectedoutliers', False] Returns ------- @@ -216,7 +222,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -236,7 +242,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -256,11 +262,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -281,10 +288,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -320,9 +328,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.box.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -342,7 +350,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['boxes', 'points'] joined with '+' characters + + - Any combination of ['boxes', 'points'] joined with '+' characters (e.g. 'boxes+points') Returns @@ -383,9 +392,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -422,9 +434,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -502,7 +517,8 @@ def jitter(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -545,8 +561,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -563,9 +581,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.box.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -591,7 +609,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -610,7 +628,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -627,9 +646,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.box.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -687,9 +706,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.box.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -831,8 +850,10 @@ def name(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -919,7 +940,8 @@ def notchwidth(self): 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] + + - An int or float in the interval [0, 0.5] Returns ------- @@ -939,8 +961,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -958,7 +982,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -977,8 +1002,10 @@ def orientation(self): 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -1000,7 +1027,8 @@ def pointpos(self): horizontal boxes The 'pointpos' property is a number and may be specified as: - - An int or float in the interval [-2, 2] + + - An int or float in the interval [-2, 2] Returns ------- @@ -1103,8 +1131,10 @@ def quartilemethod(self): upper half. The 'quartilemethod' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'exclusive', 'inclusive'] + + - One of the following enumeration values: + + ['linear', 'exclusive', 'inclusive'] Returns ------- @@ -1146,7 +1176,8 @@ def sdmultiple(self): 5-stddev The 'sdmultiple' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -1181,9 +1212,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.box.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -1265,8 +1296,10 @@ def sizemode(self): 3-stddev etc The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['quartiles', 'sd'] + + - One of the following enumeration values: + + ['quartiles', 'sd'] Returns ------- @@ -1283,9 +1316,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.box.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -1307,9 +1340,12 @@ def text(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1346,8 +1382,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1395,9 +1433,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.box.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.box.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1458,8 +1496,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1478,7 +1518,8 @@ def whiskerwidth(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -1498,7 +1539,8 @@ def width(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1577,11 +1619,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1609,8 +1653,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1670,8 +1716,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1768,11 +1816,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1800,8 +1850,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1861,8 +1913,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1900,7 +1954,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_candlestick.py b/plotly/graph_objects/_candlestick.py index e5f47c61d6..28f7bcbf0a 100644 --- a/plotly/graph_objects/_candlestick.py +++ b/plotly/graph_objects/_candlestick.py @@ -142,9 +142,9 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.Decreasing` - - A dict of string/value properties that will be passed - to the Decreasing constructor + + - An instance of :class:`plotly.graph_objects.candlestick.Decreasing` + - A dict of string/value properties that will be passed to the Decreasing constructor Returns ------- @@ -201,10 +201,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -240,9 +241,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.candlestick.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -260,9 +261,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -336,9 +340,9 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.Increasing` - - A dict of string/value properties that will be passed - to the Increasing constructor + + - An instance of :class:`plotly.graph_objects.candlestick.Increasing` + - A dict of string/value properties that will be passed to the Increasing constructor Returns ------- @@ -381,8 +385,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -399,9 +405,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.candlestick.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -427,7 +433,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -446,7 +452,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -463,9 +470,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.candlestick.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -564,8 +571,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -583,7 +592,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -677,9 +687,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.candlestick.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -700,9 +710,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -739,8 +752,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -791,8 +806,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -811,7 +828,8 @@ def whiskerwidth(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -871,11 +889,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -903,8 +923,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -964,8 +986,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1034,8 +1058,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1055,7 +1081,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_carpet.py b/plotly/graph_objects/_carpet.py index 5c1ef13a5e..b7e989474a 100644 --- a/plotly/graph_objects/_carpet.py +++ b/plotly/graph_objects/_carpet.py @@ -76,7 +76,7 @@ def a0(self): The 'a0' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -93,9 +93,9 @@ def aaxis(self): """ The 'aaxis' property is an instance of Aaxis that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.Aaxis` - - A dict of string/value properties that will be passed - to the Aaxis constructor + + - An instance of :class:`plotly.graph_objects.carpet.Aaxis` + - A dict of string/value properties that will be passed to the Aaxis constructor Returns ------- @@ -152,7 +152,7 @@ def b0(self): The 'b0' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -169,9 +169,9 @@ def baxis(self): """ The 'baxis' property is an instance of Baxis that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.Baxis` - - A dict of string/value properties that will be passed - to the Baxis constructor + + - An instance of :class:`plotly.graph_objects.carpet.Baxis` + - A dict of string/value properties that will be passed to the Baxis constructor Returns ------- @@ -209,8 +209,10 @@ def carpet(self): lie The 'carpet' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -230,7 +232,7 @@ def cheaterslope(self): The 'cheaterslope' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -251,11 +253,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -314,7 +317,7 @@ def da(self): The 'da' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -333,7 +336,7 @@ def db(self): The 'db' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -352,9 +355,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.carpet.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -432,9 +435,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.carpet.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -460,7 +463,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -479,7 +482,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -542,8 +546,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -561,7 +567,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -578,9 +585,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.carpet.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -599,8 +606,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -651,8 +660,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -792,7 +803,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_choropleth.py b/plotly/graph_objects/_choropleth.py index 85ddda87ff..13aebefa86 100644 --- a/plotly/graph_objects/_choropleth.py +++ b/plotly/graph_objects/_choropleth.py @@ -113,9 +113,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.choropleth.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -143,30 +143,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -227,8 +228,10 @@ def featureidkey(self): "properties.name". The 'featureidkey' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -293,10 +296,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -332,9 +336,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.choropleth.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -374,9 +378,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -413,9 +420,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -515,8 +525,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -533,9 +545,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.choropleth.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -561,7 +573,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -580,7 +592,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -602,8 +615,10 @@ def locationmode(self): GeoJSON linked to the `geojson` attribute. The 'locationmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['ISO-3', 'USA-states', 'country names', 'geojson-id'] + + - One of the following enumeration values: + + ['ISO-3', 'USA-states', 'country names', 'geojson-id'] Returns ------- @@ -658,9 +673,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choropleth.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -723,8 +738,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -761,9 +778,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.choropleth.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -840,9 +857,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.choropleth.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -860,9 +877,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -899,8 +919,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -948,9 +970,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.choropleth.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -970,8 +992,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1030,7 +1054,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1051,7 +1075,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1071,7 +1095,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/_choroplethmap.py b/plotly/graph_objects/_choroplethmap.py index f081206b15..4dd8c6024e 100644 --- a/plotly/graph_objects/_choroplethmap.py +++ b/plotly/graph_objects/_choroplethmap.py @@ -92,8 +92,10 @@ def below(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -135,9 +137,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -165,30 +167,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -248,8 +251,10 @@ def featureidkey(self): property, for example "properties.name". The 'featureidkey' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -290,10 +295,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -329,9 +335,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -372,9 +378,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -411,9 +420,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -513,8 +525,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -531,9 +545,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -559,7 +573,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -578,7 +592,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -633,9 +648,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -698,8 +713,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -736,9 +753,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -815,9 +832,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -858,9 +875,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -897,8 +917,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -946,9 +968,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -968,8 +990,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1028,7 +1052,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1049,7 +1073,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1069,7 +1093,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/_choroplethmapbox.py b/plotly/graph_objects/_choroplethmapbox.py index f6106784c2..a282b076e2 100644 --- a/plotly/graph_objects/_choroplethmapbox.py +++ b/plotly/graph_objects/_choroplethmapbox.py @@ -93,8 +93,10 @@ def below(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -136,9 +138,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -166,30 +168,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -249,8 +252,10 @@ def featureidkey(self): property, for example "properties.name". The 'featureidkey' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -291,10 +296,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -330,9 +336,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -373,9 +379,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -412,9 +421,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -514,8 +526,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -532,9 +546,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -560,7 +574,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -579,7 +593,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -634,9 +649,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -699,8 +714,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -737,9 +754,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -816,9 +833,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -863,9 +880,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -902,8 +922,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -951,9 +973,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -973,8 +995,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1033,7 +1057,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1054,7 +1078,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1074,7 +1098,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/_cone.py b/plotly/graph_objects/_cone.py index bc8abdf85b..f6eb3d810a 100644 --- a/plotly/graph_objects/_cone.py +++ b/plotly/graph_objects/_cone.py @@ -81,8 +81,10 @@ def anchor(self): 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'] + + - One of the following enumeration values: + + ['tip', 'tail', 'cm', 'center'] Returns ------- @@ -147,7 +149,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -169,7 +171,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -190,7 +192,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -232,9 +234,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.cone.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -262,30 +264,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -346,10 +349,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -385,9 +389,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.cone.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -428,9 +432,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -467,9 +474,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -569,8 +579,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -587,9 +599,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.cone.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -615,7 +627,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -634,7 +646,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -651,9 +664,9 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.Lighting` - - A dict of string/value properties that will be passed - to the Lighting constructor + + - An instance of :class:`plotly.graph_objects.cone.Lighting` + - A dict of string/value properties that will be passed to the Lighting constructor Returns ------- @@ -670,9 +683,9 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.Lightposition` - - A dict of string/value properties that will be passed - to the Lightposition constructor + + - An instance of :class:`plotly.graph_objects.cone.Lightposition` + - A dict of string/value properties that will be passed to the Lightposition constructor Returns ------- @@ -735,8 +748,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -759,7 +774,8 @@ def opacity(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -862,8 +878,10 @@ def sizemode(self): "raw". The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['scaled', 'absolute', 'raw'] + + - One of the following enumeration values: + + ['scaled', 'absolute', 'raw'] Returns ------- @@ -891,7 +909,8 @@ def sizeref(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -908,9 +927,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.cone.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -930,9 +949,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -990,8 +1012,10 @@ def uhoverformat(self): default the values are formatted using generic number format. The 'uhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1010,8 +1034,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1100,8 +1126,10 @@ def vhoverformat(self): default the values are formatted using generic number format. The 'vhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1121,8 +1149,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1180,8 +1210,10 @@ def whoverformat(self): default the values are formatted using generic number format. The 'whoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1246,8 +1278,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1312,8 +1346,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1378,8 +1414,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_contour.py b/plotly/graph_objects/_contour.py index a2d3a8842c..b463eca9f2 100644 --- a/plotly/graph_objects/_contour.py +++ b/plotly/graph_objects/_contour.py @@ -159,9 +159,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.contour.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -189,30 +189,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -249,9 +250,9 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.Contours` - - A dict of string/value properties that will be passed - to the Contours constructor + + - An instance of :class:`plotly.graph_objects.contour.Contours` + - A dict of string/value properties that will be passed to the Contours constructor Returns ------- @@ -310,7 +311,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -329,7 +330,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -349,13 +350,13 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to contour.colorscale + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to contour.colorscale Returns ------- @@ -376,10 +377,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -415,9 +417,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.contour.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -476,9 +478,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -615,8 +620,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -633,9 +640,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.contour.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -661,7 +668,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -680,7 +687,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -697,9 +705,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.contour.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -762,8 +770,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -784,7 +794,8 @@ def ncontours(self): `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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -803,7 +814,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -878,9 +890,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.contour.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -918,9 +930,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.contour.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -970,8 +982,10 @@ def texttemplate(self): `z` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1008,8 +1022,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1060,8 +1076,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1139,11 +1157,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1171,8 +1191,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1232,8 +1254,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1272,8 +1296,10 @@ def xtype(self): 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'] + + - One of the following enumeration values: + + ['array', 'scaled'] Returns ------- @@ -1351,11 +1377,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1383,8 +1411,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1444,8 +1474,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1484,8 +1516,10 @@ def ytype(self): 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'] + + - One of the following enumeration values: + + ['array', 'scaled'] Returns ------- @@ -1546,8 +1580,10 @@ def zhoverformat(self): default the values are formatted using generic number format. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1567,7 +1603,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1588,7 +1624,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1608,7 +1644,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1628,7 +1664,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_contourcarpet.py b/plotly/graph_objects/_contourcarpet.py index 5b43089df9..acc1004743 100644 --- a/plotly/graph_objects/_contourcarpet.py +++ b/plotly/graph_objects/_contourcarpet.py @@ -130,8 +130,10 @@ def atype(self): 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'] + + - One of the following enumeration values: + + ['array', 'scaled'] Returns ------- @@ -251,8 +253,10 @@ def btype(self): 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'] + + - One of the following enumeration values: + + ['array', 'scaled'] Returns ------- @@ -271,8 +275,10 @@ def carpet(self): lies The 'carpet' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -314,9 +320,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -344,30 +350,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -384,9 +391,9 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.Contours` - - A dict of string/value properties that will be passed - to the Contours constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.Contours` + - A dict of string/value properties that will be passed to the Contours constructor Returns ------- @@ -445,7 +452,7 @@ def da(self): The 'da' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -464,7 +471,7 @@ def db(self): The 'db' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -484,13 +491,13 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to contourcarpet.colorscale + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to contourcarpet.colorscale Returns ------- @@ -608,8 +615,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -626,9 +635,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -654,7 +663,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -673,7 +682,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -690,9 +700,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -755,8 +765,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -777,7 +789,8 @@ def ncontours(self): `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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -796,7 +809,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -871,9 +885,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -946,8 +960,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -998,8 +1014,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1104,7 +1122,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1125,7 +1143,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1145,7 +1163,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1165,7 +1183,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_densitymap.py b/plotly/graph_objects/_densitymap.py index a5dc66f2b2..d19527913d 100644 --- a/plotly/graph_objects/_densitymap.py +++ b/plotly/graph_objects/_densitymap.py @@ -91,8 +91,10 @@ def below(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -134,9 +136,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.densitymap.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -164,30 +166,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -248,10 +251,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters + + - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters (e.g. 'lon+lat') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -287,9 +291,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.densitymap.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -329,9 +333,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -372,9 +379,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -510,8 +520,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -528,9 +540,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.densitymap.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -556,7 +568,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -575,7 +587,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -674,8 +687,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -693,7 +708,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -713,8 +729,10 @@ def radius(self): smoother, but less detailed. The 'radius' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -807,9 +825,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.densitymap.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -855,9 +873,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -894,8 +915,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -946,8 +969,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1007,7 +1032,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1028,7 +1053,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1048,7 +1073,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/_densitymapbox.py b/plotly/graph_objects/_densitymapbox.py index fd23df3d53..c60554918f 100644 --- a/plotly/graph_objects/_densitymapbox.py +++ b/plotly/graph_objects/_densitymapbox.py @@ -92,8 +92,10 @@ def below(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -135,9 +137,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -165,30 +167,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -249,10 +252,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters + + - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters (e.g. 'lon+lat') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -288,9 +292,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -330,9 +334,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -373,9 +380,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -511,8 +521,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -529,9 +541,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -557,7 +569,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -576,7 +588,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -675,8 +688,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -694,7 +709,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -714,8 +730,10 @@ def radius(self): smoother, but less detailed. The 'radius' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -808,9 +826,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -860,9 +878,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -899,8 +920,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -951,8 +974,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1012,7 +1037,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1033,7 +1058,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1053,7 +1078,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/_figure.py b/plotly/graph_objects/_figure.py index 106947c0b2..54ca4a147f 100644 --- a/plotly/graph_objects/_figure.py +++ b/plotly/graph_objects/_figure.py @@ -16,12 +16,14 @@ def __init__( data The 'data' property is a tuple of trace instances that may be specified as: - - A list or tuple of trace instances + + - A list or tuple of trace instances (e.g. [Scatter(...), Bar(...)]) - - A single trace instance + - A single trace instance (e.g. Scatter(...), Bar(...), etc.) - - A list or tuple of dicts of string/value properties where: + - A list or tuple of dicts of string/value properties where: - The 'type' property specifies the trace type + One of: ['bar', 'barpolar', 'box', 'candlestick', 'carpet', 'choropleth', 'choroplethmap', 'choroplethmapbox', 'cone', 'contour', @@ -39,23 +41,24 @@ def __init__( 'sunburst', 'surface', 'table', 'treemap', 'violin', 'volume', 'waterfall'] - - All remaining properties are passed to the constructor of - the specified trace type + - All remaining properties are passed to the constructor of + the specified trace type (e.g. [{'type': 'scatter', ...}, {'type': 'bar, ...}]) layout The 'layout' property is an instance of Layout that may be specified as: - - An instance of :class:`plotly.graph_objects.Layout` - - A dict of string/value properties that will be passed - to the Layout constructor + + - An instance of :class:`plotly.graph_objects.Layout` + - A dict of string/value properties that will be passed to the Layout constructor frames The 'frames' property is a tuple of instances of Frame that may be specified as: - - A list or tuple of instances of plotly.graph_objects.Frame - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.Frame + - A list or tuple of dicts of string/value properties that will be passed to the Frame constructor skip_invalid: bool diff --git a/plotly/graph_objects/_figurewidget.py b/plotly/graph_objects/_figurewidget.py index ff7e0307c2..061b975122 100644 --- a/plotly/graph_objects/_figurewidget.py +++ b/plotly/graph_objects/_figurewidget.py @@ -16,12 +16,14 @@ def __init__( data The 'data' property is a tuple of trace instances that may be specified as: - - A list or tuple of trace instances + + - A list or tuple of trace instances (e.g. [Scatter(...), Bar(...)]) - - A single trace instance + - A single trace instance (e.g. Scatter(...), Bar(...), etc.) - - A list or tuple of dicts of string/value properties where: + - A list or tuple of dicts of string/value properties where: - The 'type' property specifies the trace type + One of: ['bar', 'barpolar', 'box', 'candlestick', 'carpet', 'choropleth', 'choroplethmap', 'choroplethmapbox', 'cone', 'contour', @@ -39,23 +41,24 @@ def __init__( 'sunburst', 'surface', 'table', 'treemap', 'violin', 'volume', 'waterfall'] - - All remaining properties are passed to the constructor of - the specified trace type + - All remaining properties are passed to the constructor of + the specified trace type (e.g. [{'type': 'scatter', ...}, {'type': 'bar, ...}]) layout The 'layout' property is an instance of Layout that may be specified as: - - An instance of :class:`plotly.graph_objects.Layout` - - A dict of string/value properties that will be passed - to the Layout constructor + + - An instance of :class:`plotly.graph_objects.Layout` + - A dict of string/value properties that will be passed to the Layout constructor frames The 'frames' property is a tuple of instances of Frame that may be specified as: - - A list or tuple of instances of plotly.graph_objects.Frame - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.Frame + - A list or tuple of dicts of string/value properties that will be passed to the Frame constructor skip_invalid: bool diff --git a/plotly/graph_objects/_frame.py b/plotly/graph_objects/_frame.py index eded6e94de..bf52d8e499 100644 --- a/plotly/graph_objects/_frame.py +++ b/plotly/graph_objects/_frame.py @@ -19,8 +19,10 @@ def baseframe(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -55,8 +57,10 @@ def group(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -90,8 +94,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_funnel.py b/plotly/graph_objects/_funnel.py index c9667eb669..d0b44f4c8a 100644 --- a/plotly/graph_objects/_funnel.py +++ b/plotly/graph_objects/_funnel.py @@ -86,8 +86,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -125,9 +127,9 @@ def connector(self): """ The 'connector' property is an instance of Connector that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Connector` - - A dict of string/value properties that will be passed - to the Connector constructor + + - An instance of :class:`plotly.graph_objects.funnel.Connector` + - A dict of string/value properties that will be passed to the Connector constructor Returns ------- @@ -146,8 +148,10 @@ def constraintext(self): 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'] + + - One of the following enumeration values: + + ['inside', 'outside', 'both', 'none'] Returns ------- @@ -206,7 +210,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -225,7 +229,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -246,10 +250,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total'] joined with '+' characters + + - Any combination of ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total'] joined with '+' characters (e.g. 'name+x') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -285,9 +290,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.funnel.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -329,9 +334,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -372,9 +380,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -450,8 +461,10 @@ def insidetextanchor(self): `textposition` "inside" mode. The 'insidetextanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['end', 'middle', 'start'] + + - One of the following enumeration values: + + ['end', 'middle', 'start'] Returns ------- @@ -470,9 +483,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.funnel.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -515,8 +528,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -533,9 +548,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.funnel.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -561,7 +576,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -580,7 +595,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -597,9 +613,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.funnel.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -662,8 +678,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -684,7 +702,7 @@ def offset(self): The 'offset' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -704,8 +722,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -723,7 +743,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -746,8 +767,10 @@ def orientation(self): "autorange" on the "y-axis" are set to "reversed". The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['v', 'h'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -766,9 +789,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.funnel.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -826,9 +849,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.funnel.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -851,9 +874,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -895,9 +921,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.funnel.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -918,7 +944,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'percent initial', 'percent previous', 'percent total', 'value'] joined with '+' characters + + - Any combination of ['label', 'text', 'percent initial', 'percent previous', 'percent total', 'value'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -945,9 +972,12 @@ def textposition(self): text appears. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['inside', 'outside', 'auto', 'none'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['inside', 'outside', 'auto', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1016,9 +1046,12 @@ def texttemplate(self): and `value`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1056,8 +1089,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1108,8 +1143,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1127,7 +1164,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1215,8 +1253,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1276,8 +1316,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1383,8 +1425,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1444,8 +1488,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1483,7 +1529,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_funnelarea.py b/plotly/graph_objects/_funnelarea.py index f2399fec75..57b2e0d531 100644 --- a/plotly/graph_objects/_funnelarea.py +++ b/plotly/graph_objects/_funnelarea.py @@ -64,7 +64,8 @@ def aspectratio(self): Sets the ratio between height and width The 'aspectratio' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -82,7 +83,8 @@ def baseratio(self): Sets the ratio between bottom length and maximum top length. The 'baseratio' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -141,7 +143,7 @@ def dlabel(self): The 'dlabel' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -158,9 +160,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -181,10 +183,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -220,9 +223,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -264,9 +267,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -307,9 +313,12 @@ def hovertext(self): "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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -385,9 +394,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -408,7 +417,7 @@ def label0(self): The 'label0' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -491,8 +500,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -509,9 +520,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -537,7 +548,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -556,7 +567,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -573,9 +585,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -638,8 +650,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -657,7 +671,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -677,8 +692,10 @@ def scalegroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -714,9 +731,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -757,9 +774,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -778,7 +795,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -798,9 +816,12 @@ def textposition(self): Specifies the location of the `textinfo`. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['inside', 'none'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['inside', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -868,9 +889,12 @@ def texttemplate(self): `color`, `value`, `text` and `percent`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -906,9 +930,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -927,8 +951,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1016,8 +1042,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_heatmap.py b/plotly/graph_objects/_heatmap.py index 7cccc84959..b9c54eebd3 100644 --- a/plotly/graph_objects/_heatmap.py +++ b/plotly/graph_objects/_heatmap.py @@ -136,9 +136,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.heatmap.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -166,30 +166,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -269,7 +270,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -288,7 +289,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -309,10 +310,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -348,9 +350,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.heatmap.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -409,9 +411,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -548,8 +553,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -566,9 +573,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.heatmap.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -594,7 +601,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -613,7 +620,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -676,8 +684,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -695,7 +705,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -770,9 +781,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.heatmap.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -809,9 +820,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.heatmap.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -860,8 +871,10 @@ def texttemplate(self): `z` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -898,8 +911,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -950,8 +965,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1029,11 +1046,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1051,7 +1070,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1079,8 +1099,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1140,8 +1162,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1180,8 +1204,10 @@ def xtype(self): 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'] + + - One of the following enumeration values: + + ['array', 'scaled'] Returns ------- @@ -1259,11 +1285,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1281,7 +1309,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1309,8 +1338,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1370,8 +1401,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1410,8 +1443,10 @@ def ytype(self): 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'] + + - One of the following enumeration values: + + ['array', 'scaled'] Returns ------- @@ -1472,8 +1507,10 @@ def zhoverformat(self): default the values are formatted using generic number format. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1493,7 +1530,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1514,7 +1551,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1534,7 +1571,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1554,7 +1591,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -1572,8 +1610,10 @@ 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] + + - One of the following enumeration values: + + ['fast', 'best', False] Returns ------- diff --git a/plotly/graph_objects/_histogram.py b/plotly/graph_objects/_histogram.py index 3a3d6de8c4..bd17e37c1a 100644 --- a/plotly/graph_objects/_histogram.py +++ b/plotly/graph_objects/_histogram.py @@ -86,8 +86,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -153,8 +155,10 @@ def bingroup(self): histogram and histogram2d* trace can share the same `bingroup` The 'bingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -194,8 +198,10 @@ def constraintext(self): 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'] + + - One of the following enumeration values: + + ['inside', 'outside', 'both', 'none'] Returns ------- @@ -212,9 +218,9 @@ def cumulative(self): """ The 'cumulative' property is an instance of Cumulative that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Cumulative` - - A dict of string/value properties that will be passed - to the Cumulative constructor + + - An instance of :class:`plotly.graph_objects.histogram.Cumulative` + - A dict of string/value properties that will be passed to the Cumulative constructor Returns ------- @@ -271,9 +277,9 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.ErrorX` - - A dict of string/value properties that will be passed - to the ErrorX constructor + + - An instance of :class:`plotly.graph_objects.histogram.ErrorX` + - A dict of string/value properties that will be passed to the ErrorX constructor Returns ------- @@ -290,9 +296,9 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.ErrorY` - - A dict of string/value properties that will be passed - to the ErrorY constructor + + - An instance of :class:`plotly.graph_objects.histogram.ErrorY` + - A dict of string/value properties that will be passed to the ErrorY constructor Returns ------- @@ -315,8 +321,10 @@ def histfunc(self): 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'] + + - One of the following enumeration values: + + ['count', 'sum', 'avg', 'min', 'max'] Returns ------- @@ -346,9 +354,11 @@ def histnorm(self): (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'] + + - One of the following enumeration values: + + ['', 'percent', 'probability', 'density', 'probability + density'] Returns ------- @@ -369,10 +379,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -408,9 +419,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.histogram.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -451,9 +462,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -490,9 +504,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -568,8 +585,10 @@ def insidetextanchor(self): `textposition` "inside" mode. The 'insidetextanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['end', 'middle', 'start'] + + - One of the following enumeration values: + + ['end', 'middle', 'start'] Returns ------- @@ -588,9 +607,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.histogram.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -633,8 +652,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -651,9 +672,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.histogram.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -679,7 +700,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -698,7 +719,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -715,9 +737,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.histogram.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -780,8 +802,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -802,7 +826,8 @@ def nbinsx(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -824,7 +849,8 @@ def nbinsy(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -845,8 +871,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -864,7 +892,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -883,8 +912,10 @@ def orientation(self): 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -903,9 +934,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.histogram.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -922,9 +953,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.histogram.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -982,9 +1013,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.histogram.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -1005,9 +1036,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1049,9 +1083,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.histogram.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -1076,8 +1110,10 @@ def textposition(self): text appears. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['inside', 'outside', 'auto', 'none'] + + - One of the following enumeration values: + + ['inside', 'outside', 'auto', 'none'] Returns ------- @@ -1126,8 +1162,10 @@ def texttemplate(self): and `value`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1146,8 +1184,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1195,9 +1235,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.histogram.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1217,8 +1257,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1276,9 +1318,9 @@ def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.XBins` - - A dict of string/value properties that will be passed - to the XBins constructor + + - An instance of :class:`plotly.graph_objects.histogram.XBins` + - A dict of string/value properties that will be passed to the XBins constructor Returns ------- @@ -1296,11 +1338,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1328,8 +1372,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1405,9 +1451,9 @@ def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.YBins` - - A dict of string/value properties that will be passed - to the YBins constructor + + - An instance of :class:`plotly.graph_objects.histogram.YBins` + - A dict of string/value properties that will be passed to the YBins constructor Returns ------- @@ -1425,11 +1471,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1457,8 +1505,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1496,7 +1546,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_histogram2d.py b/plotly/graph_objects/_histogram2d.py index 0a0c407d4f..b48b69c654 100644 --- a/plotly/graph_objects/_histogram2d.py +++ b/plotly/graph_objects/_histogram2d.py @@ -148,8 +148,10 @@ def bingroup(self): them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -191,9 +193,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -221,30 +223,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -307,8 +310,10 @@ def histfunc(self): 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'] + + - One of the following enumeration values: + + ['count', 'sum', 'avg', 'min', 'max'] Returns ------- @@ -338,9 +343,11 @@ def histnorm(self): (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'] + + - One of the following enumeration values: + + ['', 'percent', 'probability', 'density', 'probability + density'] Returns ------- @@ -361,10 +368,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -400,9 +408,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -443,9 +451,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -545,8 +556,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -563,9 +576,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -591,7 +604,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -610,7 +623,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -627,9 +641,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -692,8 +706,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -714,7 +730,8 @@ def nbinsx(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -736,7 +753,8 @@ def nbinsy(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -755,7 +773,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -830,9 +849,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -851,9 +870,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -883,8 +902,10 @@ def texttemplate(self): Finally, the template string has access to variable `z` The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -903,8 +924,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -955,8 +978,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1019,8 +1044,10 @@ def xbingroup(self): value can be used to set (1D) histogram `bingroup` The 'xbingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1037,9 +1064,9 @@ def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.XBins` - - A dict of string/value properties that will be passed - to the XBins constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.XBins` + - A dict of string/value properties that will be passed to the XBins constructor Returns ------- @@ -1057,11 +1084,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1079,7 +1108,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1107,8 +1137,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1189,8 +1221,10 @@ def ybingroup(self): value can be used to set (1D) histogram `bingroup` The 'ybingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1207,9 +1241,9 @@ def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.YBins` - - A dict of string/value properties that will be passed - to the YBins constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.YBins` + - A dict of string/value properties that will be passed to the YBins constructor Returns ------- @@ -1227,11 +1261,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1249,7 +1285,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1277,8 +1314,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1357,8 +1396,10 @@ def zhoverformat(self): default the values are formatted using generic number format. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1378,7 +1419,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1399,7 +1440,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1419,7 +1460,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1437,8 +1478,10 @@ 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] + + - One of the following enumeration values: + + ['fast', 'best', False] Returns ------- diff --git a/plotly/graph_objects/_histogram2dcontour.py b/plotly/graph_objects/_histogram2dcontour.py index 4f9cebe88d..ae301cd980 100644 --- a/plotly/graph_objects/_histogram2dcontour.py +++ b/plotly/graph_objects/_histogram2dcontour.py @@ -170,8 +170,10 @@ def bingroup(self): them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -213,9 +215,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -243,30 +245,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -283,9 +286,9 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Contours` - - A dict of string/value properties that will be passed - to the Contours constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Contours` + - A dict of string/value properties that will be passed to the Contours constructor Returns ------- @@ -348,8 +351,10 @@ def histfunc(self): 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'] + + - One of the following enumeration values: + + ['count', 'sum', 'avg', 'min', 'max'] Returns ------- @@ -379,9 +384,11 @@ def histnorm(self): (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'] + + - One of the following enumeration values: + + ['', 'percent', 'probability', 'density', 'probability + density'] Returns ------- @@ -402,10 +409,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -441,9 +449,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -484,9 +492,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -586,8 +597,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -604,9 +617,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -632,7 +645,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -651,7 +664,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -668,9 +682,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -687,9 +701,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -752,8 +766,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -774,7 +790,8 @@ def nbinsx(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -796,7 +813,8 @@ def nbinsy(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -818,7 +836,8 @@ def ncontours(self): `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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -837,7 +856,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -912,9 +932,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -934,9 +954,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -968,8 +988,10 @@ def texttemplate(self): `z` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -988,8 +1010,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1040,8 +1064,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1104,8 +1130,10 @@ def xbingroup(self): value can be used to set (1D) histogram `bingroup` The 'xbingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1122,9 +1150,9 @@ def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.XBins` - - A dict of string/value properties that will be passed - to the XBins constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.XBins` + - A dict of string/value properties that will be passed to the XBins constructor Returns ------- @@ -1142,11 +1170,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1174,8 +1204,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1256,8 +1288,10 @@ def ybingroup(self): value can be used to set (1D) histogram `bingroup` The 'ybingroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1274,9 +1308,9 @@ def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.YBins` - - A dict of string/value properties that will be passed - to the YBins constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.YBins` + - A dict of string/value properties that will be passed to the YBins constructor Returns ------- @@ -1294,11 +1328,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1326,8 +1362,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1406,8 +1444,10 @@ def zhoverformat(self): default the values are formatted using generic number format. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1427,7 +1467,7 @@ def zmax(self): The 'zmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1448,7 +1488,7 @@ def zmid(self): The 'zmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1468,7 +1508,7 @@ def zmin(self): The 'zmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/_icicle.py b/plotly/graph_objects/_icicle.py index db26befac7..23f308107c 100644 --- a/plotly/graph_objects/_icicle.py +++ b/plotly/graph_objects/_icicle.py @@ -72,8 +72,10 @@ def branchvalues(self): leaves. The 'branchvalues' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['remainder', 'total'] + + - One of the following enumeration values: + + ['remainder', 'total'] Returns ------- @@ -94,7 +96,8 @@ def count(self): The 'count' property is a flaglist and may be specified as a string containing: - - Any combination of ['branches', 'leaves'] joined with '+' characters + + - Any combination of ['branches', 'leaves'] joined with '+' characters (e.g. 'branches+leaves') Returns @@ -152,9 +155,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.icicle.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -175,10 +178,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -214,9 +218,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.icicle.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -259,9 +263,12 @@ def hovertemplate(self): ``. 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -302,9 +309,12 @@ def hovertext(self): "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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -380,9 +390,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.icicle.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -435,9 +445,9 @@ def leaf(self): """ The 'leaf' property is an instance of Leaf that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Leaf` - - A dict of string/value properties that will be passed - to the Leaf constructor + + - An instance of :class:`plotly.graph_objects.icicle.Leaf` + - A dict of string/value properties that will be passed to the Leaf constructor Returns ------- @@ -477,9 +487,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.icicle.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -505,7 +515,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -524,7 +534,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -561,9 +572,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.icicle.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -582,7 +593,8 @@ def maxdepth(self): `maxdepth` to "-1" to render all the levels in the hierarchy. The 'maxdepth' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -645,8 +657,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -664,7 +678,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -687,9 +702,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.icicle.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -747,9 +762,9 @@ def pathbar(self): """ The 'pathbar' property is an instance of Pathbar that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Pathbar` - - A dict of string/value properties that will be passed - to the Pathbar constructor + + - An instance of :class:`plotly.graph_objects.icicle.Pathbar` + - A dict of string/value properties that will be passed to the Pathbar constructor Returns ------- @@ -766,9 +781,9 @@ def root(self): """ The 'root' property is an instance of Root that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Root` - - A dict of string/value properties that will be passed - to the Root constructor + + - An instance of :class:`plotly.graph_objects.icicle.Root` + - A dict of string/value properties that will be passed to the Root constructor Returns ------- @@ -804,9 +819,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.icicle.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -847,9 +862,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.icicle.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -868,7 +883,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -888,10 +904,12 @@ def textposition(self): Sets the positions of the `text` elements. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] + + - 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 ------- @@ -941,9 +959,12 @@ def texttemplate(self): `percentParent`, `label` and `value`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -979,9 +1000,9 @@ def tiling(self): """ The 'tiling' property is an instance of Tiling that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.Tiling` - - A dict of string/value properties that will be passed - to the Tiling constructor + + - An instance of :class:`plotly.graph_objects.icicle.Tiling` + - A dict of string/value properties that will be passed to the Tiling constructor Returns ------- @@ -1000,8 +1021,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1089,8 +1112,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_image.py b/plotly/graph_objects/_image.py index bed25fed9c..493009742b 100644 --- a/plotly/graph_objects/_image.py +++ b/plotly/graph_objects/_image.py @@ -60,8 +60,10 @@ def colormodel(self): `rgb`. The 'colormodel' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla'] + + - One of the following enumeration values: + + ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla'] Returns ------- @@ -120,7 +122,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -139,7 +141,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -160,10 +162,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['x', 'y', 'z', 'color', 'name', 'text'] joined with '+' characters + + - Any combination of ['x', 'y', 'z', 'color', 'name', 'text'] joined with '+' characters (e.g. 'x+y') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -199,9 +202,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.image.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.image.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -243,9 +246,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -379,9 +385,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.image.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.image.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -407,7 +413,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -426,7 +432,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -489,8 +496,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -508,7 +517,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -527,8 +537,10 @@ def source(self): consists of "data:image/[][;base64]," The 'source' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -545,9 +557,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.image.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.image.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -602,8 +614,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -654,8 +668,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -862,7 +878,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -881,8 +898,10 @@ def zsmooth(self): applies for image traces that use the `source` attribute. The 'zsmooth' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['fast', False] + + - One of the following enumeration values: + + ['fast', False] Returns ------- diff --git a/plotly/graph_objects/_indicator.py b/plotly/graph_objects/_indicator.py index 180678204d..fcf819fee2 100644 --- a/plotly/graph_objects/_indicator.py +++ b/plotly/graph_objects/_indicator.py @@ -43,8 +43,10 @@ def align(self): displayed: in this case, it is always centered The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -101,9 +103,9 @@ def delta(self): """ The 'delta' property is an instance of Delta that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Delta` - - A dict of string/value properties that will be passed - to the Delta constructor + + - An instance of :class:`plotly.graph_objects.indicator.Delta` + - A dict of string/value properties that will be passed to the Delta constructor Returns ------- @@ -120,9 +122,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.indicator.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -141,9 +143,9 @@ def gauge(self): The 'gauge' property is an instance of Gauge that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Gauge` - - A dict of string/value properties that will be passed - to the Gauge constructor + + - An instance of :class:`plotly.graph_objects.indicator.Gauge` + - A dict of string/value properties that will be passed to the Gauge constructor Returns ------- @@ -221,9 +223,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.indicator.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -249,7 +251,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -268,7 +270,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -334,7 +337,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['number', 'delta', 'gauge'] joined with '+' characters + + - Any combination of ['number', 'delta', 'gauge'] joined with '+' characters (e.g. 'number+delta') Returns @@ -354,8 +358,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -372,9 +378,9 @@ def number(self): """ The 'number' property is an instance of Number that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Number` - - A dict of string/value properties that will be passed - to the Number constructor + + - An instance of :class:`plotly.graph_objects.indicator.Number` + - A dict of string/value properties that will be passed to the Number constructor Returns ------- @@ -391,9 +397,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.indicator.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -410,9 +416,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.indicator.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -431,8 +437,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -482,7 +490,7 @@ def value(self): The 'value' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -502,8 +510,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_isosurface.py b/plotly/graph_objects/_isosurface.py index e984e461a3..ca70a6bae8 100644 --- a/plotly/graph_objects/_isosurface.py +++ b/plotly/graph_objects/_isosurface.py @@ -100,9 +100,9 @@ def caps(self): """ The 'caps' property is an instance of Caps that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Caps` - - A dict of string/value properties that will be passed - to the Caps constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Caps` + - A dict of string/value properties that will be passed to the Caps constructor Returns ------- @@ -143,7 +143,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -164,7 +164,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -184,7 +184,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -226,9 +226,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.isosurface.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -256,30 +256,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -296,9 +297,9 @@ def contour(self): """ The 'contour' property is an instance of Contour that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Contour` - - A dict of string/value properties that will be passed - to the Contour constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Contour` + - A dict of string/value properties that will be passed to the Contour constructor Returns ------- @@ -379,10 +380,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -418,9 +420,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -460,9 +462,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -499,9 +504,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -577,7 +585,7 @@ def isomax(self): The 'isomax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -596,7 +604,7 @@ def isomin(self): The 'isomin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -639,8 +647,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -657,9 +667,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -685,7 +695,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -704,7 +714,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -721,9 +732,9 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Lighting` - - A dict of string/value properties that will be passed - to the Lighting constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Lighting` + - A dict of string/value properties that will be passed to the Lighting constructor Returns ------- @@ -740,9 +751,9 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Lightposition` - - A dict of string/value properties that will be passed - to the Lightposition constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Lightposition` + - A dict of string/value properties that will be passed to the Lightposition constructor Returns ------- @@ -805,8 +816,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -829,7 +842,8 @@ def opacity(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -927,9 +941,9 @@ def slices(self): """ The 'slices' property is an instance of Slices that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Slices` - - A dict of string/value properties that will be passed - to the Slices constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Slices` + - A dict of string/value properties that will be passed to the Slices constructor Returns ------- @@ -946,9 +960,9 @@ def spaceframe(self): """ The 'spaceframe' property is an instance of Spaceframe that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Spaceframe` - - A dict of string/value properties that will be passed - to the Spaceframe constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Spaceframe` + - A dict of string/value properties that will be passed to the Spaceframe constructor Returns ------- @@ -965,9 +979,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -984,9 +998,9 @@ def surface(self): """ The 'surface' property is an instance of Surface that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.Surface` - - A dict of string/value properties that will be passed - to the Surface constructor + + - An instance of :class:`plotly.graph_objects.isosurface.Surface` + - A dict of string/value properties that will be passed to the Surface constructor Returns ------- @@ -1006,9 +1020,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1045,8 +1062,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1117,8 +1136,10 @@ def valuehoverformat(self): default the values are formatted using generic number format. The 'valuehoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1156,8 +1177,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1203,8 +1226,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1268,8 +1293,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1333,8 +1360,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_layout.py b/plotly/graph_objects/_layout.py index b6d9e65692..be215c50d9 100644 --- a/plotly/graph_objects/_layout.py +++ b/plotly/graph_objects/_layout.py @@ -157,9 +157,9 @@ def activeselection(self): """ The 'activeselection' property is an instance of Activeselection that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Activeselection` - - A dict of string/value properties that will be passed - to the Activeselection constructor + + - An instance of :class:`plotly.graph_objects.layout.Activeselection` + - A dict of string/value properties that will be passed to the Activeselection constructor Returns ------- @@ -176,9 +176,9 @@ def activeshape(self): """ The 'activeshape' property is an instance of Activeshape that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Activeshape` - - A dict of string/value properties that will be passed - to the Activeshape constructor + + - An instance of :class:`plotly.graph_objects.layout.Activeshape` + - A dict of string/value properties that will be passed to the Activeshape constructor Returns ------- @@ -195,8 +195,9 @@ 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_objects.layout.Annotation - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.Annotation + - A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor Returns @@ -218,9 +219,9 @@ def annotationdefaults(self): The 'annotationdefaults' property is an instance of Annotation that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Annotation` - - A dict of string/value properties that will be passed - to the Annotation constructor + + - An instance of :class:`plotly.graph_objects.layout.Annotation` + - A dict of string/value properties that will be passed to the Annotation constructor Returns ------- @@ -264,8 +265,10 @@ def autotypenumbers(self): overridden for individual axes. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -302,7 +305,8 @@ def bargap(self): location coordinates. The 'bargap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -321,7 +325,8 @@ def bargroupgap(self): location coordinate. The 'bargroupgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -346,8 +351,10 @@ def barmode(self): "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'] + + - One of the following enumeration values: + + ['stack', 'group', 'overlay', 'relative'] Returns ------- @@ -368,8 +375,10 @@ def barnorm(self): 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'] + + - One of the following enumeration values: + + ['', 'fraction', 'percent'] Returns ------- @@ -389,7 +398,8 @@ def boxgap(self): set. The 'boxgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -409,7 +419,8 @@ def boxgroupgap(self): set. The 'boxgroupgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -432,8 +443,10 @@ def boxmode(self): 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'] + + - One of the following enumeration values: + + ['group', 'overlay'] Returns ------- @@ -452,11 +465,13 @@ def calendar(self): displaying dates throughout the plot. The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -487,7 +502,8 @@ def clickmode(self): The 'clickmode' property is a flaglist and may be specified as a string containing: - - Any combination of ['event', 'select'] joined with '+' characters + + - Any combination of ['event', 'select'] joined with '+' characters (e.g. 'event+select') OR exactly one of ['none'] (e.g. 'none') @@ -506,9 +522,9 @@ def coloraxis(self): """ The 'coloraxis' property is an instance of Coloraxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Coloraxis` - - A dict of string/value properties that will be passed - to the Coloraxis constructor + + - An instance of :class:`plotly.graph_objects.layout.Coloraxis` + - A dict of string/value properties that will be passed to the Coloraxis constructor Returns ------- @@ -525,9 +541,9 @@ def colorscale(self): """ The 'colorscale' property is an instance of Colorscale that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Colorscale` - - A dict of string/value properties that will be passed - to the Colorscale constructor + + - An instance of :class:`plotly.graph_objects.layout.Colorscale` + - A dict of string/value properties that will be passed to the Colorscale constructor Returns ------- @@ -608,10 +624,12 @@ def dragmode(self): "turntable" apply only to 3D scenes. The 'dragmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['zoom', 'pan', 'select', 'lasso', 'drawclosedpath', - 'drawopenpath', 'drawline', 'drawrect', 'drawcircle', - 'orbit', 'turntable', False] + + - One of the following enumeration values: + + ['zoom', 'pan', 'select', 'lasso', 'drawclosedpath', + 'drawopenpath', 'drawline', 'drawrect', 'drawcircle', 'orbit', + 'turntable', False] Returns ------- @@ -774,9 +792,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -817,7 +835,8 @@ def funnelgap(self): location coordinates. The 'funnelgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -836,7 +855,8 @@ def funnelgroupgap(self): location coordinate. The 'funnelgroupgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -859,8 +879,10 @@ def funnelmode(self): need to reduce "opacity" to see multiple bars. The 'funnelmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['stack', 'group', 'overlay'] + + - One of the following enumeration values: + + ['stack', 'group', 'overlay'] Returns ------- @@ -877,9 +899,9 @@ def geo(self): """ The 'geo' property is an instance of Geo that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Geo` - - A dict of string/value properties that will be passed - to the Geo constructor + + - An instance of :class:`plotly.graph_objects.layout.Geo` + - A dict of string/value properties that will be passed to the Geo constructor Returns ------- @@ -896,9 +918,9 @@ def grid(self): """ The 'grid' property is an instance of Grid that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Grid` - - A dict of string/value properties that will be passed - to the Grid constructor + + - An instance of :class:`plotly.graph_objects.layout.Grid` + - A dict of string/value properties that will be passed to the Grid constructor Returns ------- @@ -916,7 +938,8 @@ 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] + + - An int or float in the interval [10, inf] Returns ------- @@ -1001,7 +1024,8 @@ def hoverdistance(self): 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) + + - An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807] Returns @@ -1019,9 +1043,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.layout.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -1050,8 +1074,10 @@ def hovermode(self): false, hover interactions are disabled. The 'hovermode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['x', 'y', 'closest', False, 'x unified', 'y unified'] + + - One of the following enumeration values: + + ['x', 'y', 'closest', False, 'x unified', 'y unified'] Returns ------- @@ -1074,8 +1100,10 @@ def hoversubplots(self): `hovermode` is set to "x", *x unified*, "y" or *y unified*. The 'hoversubplots' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['single', 'overlaying', 'axis'] + + - One of the following enumeration values: + + ['single', 'overlaying', 'axis'] Returns ------- @@ -1114,8 +1142,9 @@ 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_objects.layout.Image - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.Image + - A list or tuple of dicts of string/value properties that will be passed to the Image constructor Returns @@ -1137,9 +1166,9 @@ def imagedefaults(self): The 'imagedefaults' property is an instance of Image that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Image` - - A dict of string/value properties that will be passed - to the Image constructor + + - An instance of :class:`plotly.graph_objects.layout.Image` + - A dict of string/value properties that will be passed to the Image constructor Returns ------- @@ -1156,9 +1185,9 @@ def legend(self): """ The 'legend' property is an instance of Legend that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Legend` - - A dict of string/value properties that will be passed - to the Legend constructor + + - An instance of :class:`plotly.graph_objects.layout.Legend` + - A dict of string/value properties that will be passed to the Legend constructor Returns ------- @@ -1175,9 +1204,9 @@ def map(self): """ The 'map' property is an instance of Map that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Map` - - A dict of string/value properties that will be passed - to the Map constructor + + - An instance of :class:`plotly.graph_objects.layout.Map` + - A dict of string/value properties that will be passed to the Map constructor Returns ------- @@ -1194,9 +1223,9 @@ def mapbox(self): """ The 'mapbox' property is an instance of Mapbox that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Mapbox` - - A dict of string/value properties that will be passed - to the Mapbox constructor + + - An instance of :class:`plotly.graph_objects.layout.Mapbox` + - A dict of string/value properties that will be passed to the Mapbox constructor Returns ------- @@ -1213,9 +1242,9 @@ def margin(self): """ The 'margin' property is an instance of Margin that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Margin` - - A dict of string/value properties that will be passed - to the Margin constructor + + - An instance of :class:`plotly.graph_objects.layout.Margin` + - A dict of string/value properties that will be passed to the Margin constructor Returns ------- @@ -1276,7 +1305,8 @@ def minreducedheight(self): px) The 'minreducedheight' property is a number and may be specified as: - - An int or float in the interval [2, inf] + + - An int or float in the interval [2, inf] Returns ------- @@ -1295,7 +1325,8 @@ def minreducedwidth(self): px) The 'minreducedwidth' property is a number and may be specified as: - - An int or float in the interval [2, inf] + + - An int or float in the interval [2, inf] Returns ------- @@ -1312,9 +1343,9 @@ def modebar(self): """ The 'modebar' property is an instance of Modebar that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Modebar` - - A dict of string/value properties that will be passed - to the Modebar constructor + + - An instance of :class:`plotly.graph_objects.layout.Modebar` + - A dict of string/value properties that will be passed to the Modebar constructor Returns ------- @@ -1331,9 +1362,9 @@ def newselection(self): """ The 'newselection' property is an instance of Newselection that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Newselection` - - A dict of string/value properties that will be passed - to the Newselection constructor + + - An instance of :class:`plotly.graph_objects.layout.Newselection` + - A dict of string/value properties that will be passed to the Newselection constructor Returns ------- @@ -1350,9 +1381,9 @@ def newshape(self): """ The 'newshape' property is an instance of Newshape that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Newshape` - - A dict of string/value properties that will be passed - to the Newshape constructor + + - An instance of :class:`plotly.graph_objects.layout.Newshape` + - A dict of string/value properties that will be passed to the Newshape constructor Returns ------- @@ -1371,11 +1402,12 @@ def paper_bgcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1416,11 +1448,12 @@ def plot_bgcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1437,9 +1470,9 @@ def polar(self): """ The 'polar' property is an instance of Polar that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Polar` - - A dict of string/value properties that will be passed - to the Polar constructor + + - An instance of :class:`plotly.graph_objects.layout.Polar` + - A dict of string/value properties that will be passed to the Polar constructor Returns ------- @@ -1458,7 +1491,8 @@ def scattergap(self): adjacent location coordinates. Defaults to `bargap`. The 'scattergap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -1481,8 +1515,10 @@ def scattermode(self): scatter points. The 'scattermode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['group', 'overlay'] + + - One of the following enumeration values: + + ['group', 'overlay'] Returns ------- @@ -1499,9 +1535,9 @@ def scene(self): """ The 'scene' property is an instance of Scene that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Scene` - - A dict of string/value properties that will be passed - to the Scene constructor + + - An instance of :class:`plotly.graph_objects.layout.Scene` + - A dict of string/value properties that will be passed to the Scene constructor Returns ------- @@ -1522,8 +1558,10 @@ def selectdirection(self): 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'] + + - One of the following enumeration values: + + ['h', 'v', 'd', 'any'] Returns ------- @@ -1558,8 +1596,9 @@ def selections(self): """ The 'selections' property is a tuple of instances of Selection that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.Selection - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.Selection + - A list or tuple of dicts of string/value properties that will be passed to the Selection constructor Returns @@ -1581,9 +1620,9 @@ def selectiondefaults(self): The 'selectiondefaults' property is an instance of Selection that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Selection` - - A dict of string/value properties that will be passed - to the Selection constructor + + - An instance of :class:`plotly.graph_objects.layout.Selection` + - A dict of string/value properties that will be passed to the Selection constructor Returns ------- @@ -1604,8 +1643,10 @@ def separators(self): default. The 'separators' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1622,8 +1663,9 @@ 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_objects.layout.Shape - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.Shape + - A list or tuple of dicts of string/value properties that will be passed to the Shape constructor Returns @@ -1645,9 +1687,9 @@ def shapedefaults(self): The 'shapedefaults' property is an instance of Shape that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Shape` - - A dict of string/value properties that will be passed - to the Shape constructor + + - An instance of :class:`plotly.graph_objects.layout.Shape` + - A dict of string/value properties that will be passed to the Shape constructor Returns ------- @@ -1686,8 +1728,9 @@ 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_objects.layout.Slider - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.Slider + - A list or tuple of dicts of string/value properties that will be passed to the Slider constructor Returns @@ -1709,9 +1752,9 @@ def sliderdefaults(self): The 'sliderdefaults' property is an instance of Slider that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Slider` - - A dict of string/value properties that will be passed - to the Slider constructor + + - An instance of :class:`plotly.graph_objects.layout.Slider` + - A dict of string/value properties that will be passed to the Slider constructor Returns ------- @@ -1728,9 +1771,9 @@ def smith(self): """ The 'smith' property is an instance of Smith that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Smith` - - A dict of string/value properties that will be passed - to the Smith constructor + + - An instance of :class:`plotly.graph_objects.layout.Smith` + - A dict of string/value properties that will be passed to the Smith constructor Returns ------- @@ -1752,7 +1795,8 @@ def spikedistance(self): 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) + + - An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807] Returns @@ -1812,9 +1856,9 @@ def template(self): The 'template' property is an instance of Template that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Template` - - A dict of string/value properties that will be passed - to the Template constructor + + - An instance of :class:`plotly.graph_objects.layout.Template` + - A dict of string/value properties that will be passed to the Template constructor - 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: @@ -1842,9 +1886,9 @@ def ternary(self): """ The 'ternary' property is an instance of Ternary that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Ternary` - - A dict of string/value properties that will be passed - to the Ternary constructor + + - An instance of :class:`plotly.graph_objects.layout.Ternary` + - A dict of string/value properties that will be passed to the Ternary constructor Returns ------- @@ -1861,9 +1905,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1882,9 +1926,9 @@ def transition(self): The 'transition' property is an instance of Transition that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Transition` - - A dict of string/value properties that will be passed - to the Transition constructor + + - An instance of :class:`plotly.graph_objects.layout.Transition` + - A dict of string/value properties that will be passed to the Transition constructor Returns ------- @@ -1955,9 +1999,9 @@ def uniformtext(self): """ The 'uniformtext' property is an instance of Uniformtext that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Uniformtext` - - A dict of string/value properties that will be passed - to the Uniformtext constructor + + - An instance of :class:`plotly.graph_objects.layout.Uniformtext` + - A dict of string/value properties that will be passed to the Uniformtext constructor Returns ------- @@ -1974,8 +2018,9 @@ 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_objects.layout.Updatemenu - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.Updatemenu + - A list or tuple of dicts of string/value properties that will be passed to the Updatemenu constructor Returns @@ -1997,9 +2042,9 @@ def updatemenudefaults(self): The 'updatemenudefaults' property is an instance of Updatemenu that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.Updatemenu` - - A dict of string/value properties that will be passed - to the Updatemenu constructor + + - An instance of :class:`plotly.graph_objects.layout.Updatemenu` + - A dict of string/value properties that will be passed to the Updatemenu constructor Returns ------- @@ -2019,7 +2064,8 @@ def violingap(self): set. The 'violingap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -2039,7 +2085,8 @@ def violingroupgap(self): set. The 'violingroupgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -2062,8 +2109,10 @@ def violinmode(self): 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'] + + - One of the following enumeration values: + + ['group', 'overlay'] Returns ------- @@ -2082,7 +2131,8 @@ def waterfallgap(self): location coordinates. The 'waterfallgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -2101,7 +2151,8 @@ def waterfallgroupgap(self): location coordinate. The 'waterfallgroupgap' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -2123,8 +2174,10 @@ def waterfallmode(self): need to reduce "opacity" to see multiple bars. The 'waterfallmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['group', 'overlay'] + + - One of the following enumeration values: + + ['group', 'overlay'] Returns ------- @@ -2142,7 +2195,8 @@ 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] + + - An int or float in the interval [10, inf] Returns ------- @@ -2159,9 +2213,9 @@ def xaxis(self): """ The 'xaxis' property is an instance of XAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.XAxis` - - A dict of string/value properties that will be passed - to the XAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.XAxis` + - A dict of string/value properties that will be passed to the XAxis constructor Returns ------- @@ -2178,9 +2232,9 @@ def yaxis(self): """ The 'yaxis' property is an instance of YAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.YAxis` - - A dict of string/value properties that will be passed - to the YAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.YAxis` + - A dict of string/value properties that will be passed to the YAxis constructor Returns ------- diff --git a/plotly/graph_objects/_mesh3d.py b/plotly/graph_objects/_mesh3d.py index b826ae0756..afc56c0890 100644 --- a/plotly/graph_objects/_mesh3d.py +++ b/plotly/graph_objects/_mesh3d.py @@ -104,7 +104,7 @@ def alphahull(self): The 'alphahull' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -169,7 +169,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -191,7 +191,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -212,7 +212,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -230,13 +230,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to mesh3d.colorscale + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to mesh3d.colorscale Returns ------- @@ -278,9 +278,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -308,30 +308,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -348,9 +349,9 @@ def contour(self): """ The 'contour' property is an instance of Contour that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.Contour` - - A dict of string/value properties that will be passed - to the Contour constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.Contour` + - A dict of string/value properties that will be passed to the Contour constructor Returns ------- @@ -411,8 +412,10 @@ def delaunayaxis(self): indicate Delaunay triangulation. The 'delaunayaxis' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['x', 'y', 'z'] + + - One of the following enumeration values: + + ['x', 'y', 'z'] Returns ------- @@ -491,10 +494,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -530,9 +534,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -572,9 +576,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -611,9 +618,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -731,8 +741,10 @@ def intensitymode(self): Determines the source of `intensity` values. The 'intensitymode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['vertex', 'cell'] + + - One of the following enumeration values: + + ['vertex', 'cell'] Returns ------- @@ -896,8 +908,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -914,9 +928,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -942,7 +956,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -961,7 +975,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -978,9 +993,9 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.Lighting` - - A dict of string/value properties that will be passed - to the Lighting constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.Lighting` + - A dict of string/value properties that will be passed to the Lighting constructor Returns ------- @@ -997,9 +1012,9 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.Lightposition` - - A dict of string/value properties that will be passed - to the Lightposition constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.Lightposition` + - A dict of string/value properties that will be passed to the Lightposition constructor Returns ------- @@ -1062,8 +1077,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1086,7 +1103,8 @@ def opacity(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -1184,9 +1202,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -1206,9 +1224,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1245,8 +1266,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1337,8 +1360,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1376,11 +1401,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1408,8 +1435,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1465,11 +1494,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1497,8 +1528,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1554,11 +1587,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1586,8 +1621,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_ohlc.py b/plotly/graph_objects/_ohlc.py index 42aad5137d..8073c8ff1a 100644 --- a/plotly/graph_objects/_ohlc.py +++ b/plotly/graph_objects/_ohlc.py @@ -142,9 +142,9 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.Decreasing` - - A dict of string/value properties that will be passed - to the Decreasing constructor + + - An instance of :class:`plotly.graph_objects.ohlc.Decreasing` + - A dict of string/value properties that will be passed to the Decreasing constructor Returns ------- @@ -201,10 +201,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -240,9 +241,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.ohlc.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -260,9 +261,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -336,9 +340,9 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.Increasing` - - A dict of string/value properties that will be passed - to the Increasing constructor + + - An instance of :class:`plotly.graph_objects.ohlc.Increasing` + - A dict of string/value properties that will be passed to the Increasing constructor Returns ------- @@ -381,8 +385,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -399,9 +405,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.ohlc.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -427,7 +433,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -446,7 +452,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -463,9 +470,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.ohlc.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -564,8 +571,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -583,7 +592,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -677,9 +687,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.ohlc.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -700,9 +710,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -739,7 +752,8 @@ def tickwidth(self): minimal interval. The 'tickwidth' property is a number and may be specified as: - - An int or float in the interval [0, 0.5] + + - An int or float in the interval [0, 0.5] Returns ------- @@ -758,8 +772,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -810,8 +826,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -871,11 +889,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -903,8 +923,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -964,8 +986,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1034,8 +1058,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1055,7 +1081,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_parcats.py b/plotly/graph_objects/_parcats.py index 01a4198eeb..12d972a4c3 100644 --- a/plotly/graph_objects/_parcats.py +++ b/plotly/graph_objects/_parcats.py @@ -45,8 +45,10 @@ def arrangement(self): dimensions are stationary. The 'arrangement' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['perpendicular', 'freeform', 'fixed'] + + - One of the following enumeration values: + + ['perpendicular', 'freeform', 'fixed'] Returns ------- @@ -84,8 +86,10 @@ def counts(self): 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -122,8 +126,9 @@ 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_objects.parcats.Dimension - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.parcats.Dimension + - A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor Returns @@ -146,9 +151,9 @@ def dimensiondefaults(self): The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Dimension` - - A dict of string/value properties that will be passed - to the Dimension constructor + + - An instance of :class:`plotly.graph_objects.parcats.Dimension` + - A dict of string/value properties that will be passed to the Dimension constructor Returns ------- @@ -165,9 +170,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.parcats.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -188,7 +193,8 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['count', 'probability'] joined with '+' characters + + - Any combination of ['count', 'probability'] joined with '+' characters (e.g. 'count+probability') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') @@ -212,8 +218,10 @@ def hoveron(self): categories per dimension. The 'hoveron' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['category', 'color', 'dimension'] + + - One of the following enumeration values: + + ['category', 'color', 'dimension'] Returns ------- @@ -259,8 +267,10 @@ def hovertemplate(self): ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -279,9 +289,9 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Labelfont` - - A dict of string/value properties that will be passed - to the Labelfont constructor + + - An instance of :class:`plotly.graph_objects.parcats.Labelfont` + - A dict of string/value properties that will be passed to the Labelfont constructor Returns ------- @@ -298,9 +308,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.parcats.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -319,7 +329,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -336,9 +347,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.parcats.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -401,8 +412,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -422,8 +435,10 @@ def sortpaths(self): 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'] + + - One of the following enumeration values: + + ['forward', 'backward'] Returns ------- @@ -440,9 +455,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.parcats.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -461,9 +476,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.parcats.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -482,8 +497,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -534,8 +551,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_parcoords.py b/plotly/graph_objects/_parcoords.py index 9ae5db8ada..5e847a239c 100644 --- a/plotly/graph_objects/_parcoords.py +++ b/plotly/graph_objects/_parcoords.py @@ -85,8 +85,9 @@ 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_objects.parcoords.Dimension - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.parcoords.Dimension + - A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor Returns @@ -109,9 +110,9 @@ def dimensiondefaults(self): The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Dimension` - - A dict of string/value properties that will be passed - to the Dimension constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Dimension` + - A dict of string/value properties that will be passed to the Dimension constructor Returns ------- @@ -128,9 +129,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -210,9 +211,9 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Labelfont` - - A dict of string/value properties that will be passed - to the Labelfont constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Labelfont` + - A dict of string/value properties that will be passed to the Labelfont constructor Returns ------- @@ -233,8 +234,10 @@ def labelside(self): inside margins when `labelposition` is set to "bottom". The 'labelside' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'bottom'] + + - One of the following enumeration values: + + ['top', 'bottom'] Returns ------- @@ -274,9 +277,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -302,7 +305,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -321,7 +324,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -338,9 +342,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -403,8 +407,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -423,9 +429,9 @@ def rangefont(self): The 'rangefont' property is an instance of Rangefont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Rangefont` - - A dict of string/value properties that will be passed - to the Rangefont constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Rangefont` + - A dict of string/value properties that will be passed to the Rangefont constructor Returns ------- @@ -442,9 +448,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -463,9 +469,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -484,8 +490,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -533,9 +541,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.parcoords.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -555,8 +563,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_pie.py b/plotly/graph_objects/_pie.py index 81207e9f65..c10ca0c203 100644 --- a/plotly/graph_objects/_pie.py +++ b/plotly/graph_objects/_pie.py @@ -130,8 +130,10 @@ def direction(self): another. The 'direction' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['clockwise', 'counterclockwise'] + + - One of the following enumeration values: + + ['clockwise', 'counterclockwise'] Returns ------- @@ -150,7 +152,7 @@ def dlabel(self): The 'dlabel' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -167,9 +169,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.pie.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -188,7 +190,8 @@ def hole(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -209,10 +212,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -248,9 +252,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.pie.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -292,9 +296,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -335,9 +342,12 @@ def hovertext(self): "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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -413,9 +423,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.pie.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -440,8 +450,10 @@ def insidetextorientation(self): to the radius of the sector. The 'insidetextorientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['horizontal', 'radial', 'tangential', 'auto'] + + - One of the following enumeration values: + + ['horizontal', 'radial', 'tangential', 'auto'] Returns ------- @@ -462,7 +474,7 @@ def label0(self): The 'label0' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -545,8 +557,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -563,9 +577,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.pie.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -591,7 +605,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -610,7 +624,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -627,9 +642,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.pie.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -692,8 +707,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -711,7 +728,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -730,9 +748,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.pie.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -753,8 +771,10 @@ def pull(self): 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -813,8 +833,10 @@ def scalegroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -869,9 +891,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.pie.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -912,9 +934,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.pie.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -933,7 +955,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -953,9 +976,12 @@ 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 + + - One of the following enumeration values: + + ['inside', 'outside', 'auto', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1023,9 +1049,12 @@ def texttemplate(self): `color`, `value`, `percent` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1061,9 +1090,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.pie.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1082,8 +1111,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1171,8 +1202,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_sankey.py b/plotly/graph_objects/_sankey.py index 6136ac9580..79706cf80b 100644 --- a/plotly/graph_objects/_sankey.py +++ b/plotly/graph_objects/_sankey.py @@ -50,8 +50,10 @@ def arrangement(self): are stationary. The 'arrangement' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['snap', 'perpendicular', 'freeform', 'fixed'] + + - One of the following enumeration values: + + ['snap', 'perpendicular', 'freeform', 'fixed'] Returns ------- @@ -108,9 +110,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.sankey.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -133,7 +135,8 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of [] joined with '+' characters + + - Any combination of [] joined with '+' characters (e.g. '') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') @@ -152,9 +155,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.sankey.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -232,9 +235,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.sankey.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -260,7 +263,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -279,7 +282,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -298,9 +302,9 @@ def link(self): The 'link' property is an instance of Link that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Link` - - A dict of string/value properties that will be passed - to the Link constructor + + - An instance of :class:`plotly.graph_objects.sankey.Link` + - A dict of string/value properties that will be passed to the Link constructor Returns ------- @@ -363,8 +367,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -383,9 +389,9 @@ def node(self): The 'node' property is an instance of Node that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Node` - - A dict of string/value properties that will be passed - to the Node constructor + + - An instance of :class:`plotly.graph_objects.sankey.Node` + - A dict of string/value properties that will be passed to the Node constructor Returns ------- @@ -403,8 +409,10 @@ 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -443,9 +451,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.sankey.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -464,9 +472,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.sankey.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -485,8 +493,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -538,8 +548,10 @@ def valueformat(self): https://github.com/d3/d3-format/tree/v1.4.5#d3-format. The 'valueformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -558,8 +570,10 @@ def valuesuffix(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -579,8 +593,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scatter.py b/plotly/graph_objects/_scatter.py index 731247eddc..5badebd2cc 100644 --- a/plotly/graph_objects/_scatter.py +++ b/plotly/graph_objects/_scatter.py @@ -94,8 +94,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -194,7 +196,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -213,7 +215,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -230,9 +232,9 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.ErrorX` - - A dict of string/value properties that will be passed - to the ErrorX constructor + + - An instance of :class:`plotly.graph_objects.scatter.ErrorX` + - A dict of string/value properties that will be passed to the ErrorX constructor Returns ------- @@ -249,9 +251,9 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.ErrorY` - - A dict of string/value properties that will be passed - to the ErrorY constructor + + - An instance of :class:`plotly.graph_objects.scatter.ErrorY` + - A dict of string/value properties that will be passed to the ErrorY constructor Returns ------- @@ -287,9 +289,11 @@ def fill(self): 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'] + + - One of the following enumeration values: + + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', 'toself', + 'tonext'] Returns ------- @@ -311,11 +315,12 @@ def fillcolor(self): label, if any. The 'fillcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,9 +340,9 @@ def fillgradient(self): The 'fillgradient' property is an instance of Fillgradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Fillgradient` - - A dict of string/value properties that will be passed - to the Fillgradient constructor + + - An instance of :class:`plotly.graph_objects.scatter.Fillgradient` + - A dict of string/value properties that will be passed to the Fillgradient constructor Returns ------- @@ -356,9 +361,9 @@ def fillpattern(self): The 'fillpattern' property is an instance of Fillpattern that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Fillpattern` - - A dict of string/value properties that will be passed - to the Fillpattern constructor + + - An instance of :class:`plotly.graph_objects.scatter.Fillpattern` + - A dict of string/value properties that will be passed to the Fillpattern constructor Returns ------- @@ -384,8 +389,10 @@ def groupnorm(self): 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'] + + - One of the following enumeration values: + + ['', 'fraction', 'percent'] Returns ------- @@ -406,10 +413,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -445,9 +453,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scatter.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -469,7 +477,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters + + - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns @@ -510,9 +519,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -553,9 +565,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -655,8 +670,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -673,9 +690,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scatter.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -701,7 +718,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -720,7 +737,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -737,9 +755,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatter.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -756,9 +774,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatter.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -826,7 +844,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -847,8 +866,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -868,8 +889,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -887,7 +910,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -911,8 +935,10 @@ def orientation(self): value of `fill`. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['v', 'h'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -929,9 +955,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scatter.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -997,8 +1023,10 @@ def stackgaps(self): 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'] + + - One of the following enumeration values: + + ['infer zero', 'interpolate'] Returns ------- @@ -1027,8 +1055,10 @@ def stackgroup(self): order. The 'stackgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1045,9 +1075,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scatter.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -1070,9 +1100,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1091,9 +1124,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatter.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -1112,11 +1145,14 @@ def textposition(self): (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 + + - 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 ------- @@ -1182,9 +1218,12 @@ def texttemplate(self): point (the ones that are `arrayOk: true`) are available. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1222,8 +1261,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1271,9 +1312,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scatter.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1293,8 +1334,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1372,11 +1415,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1404,8 +1449,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1465,8 +1512,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1562,11 +1611,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1594,8 +1645,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1655,8 +1708,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1694,7 +1749,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_scatter3d.py b/plotly/graph_objects/_scatter3d.py index 1aa95c6a70..1112b389d8 100644 --- a/plotly/graph_objects/_scatter3d.py +++ b/plotly/graph_objects/_scatter3d.py @@ -131,9 +131,9 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.ErrorX` - - A dict of string/value properties that will be passed - to the ErrorX constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.ErrorX` + - A dict of string/value properties that will be passed to the ErrorX constructor Returns ------- @@ -150,9 +150,9 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.ErrorY` - - A dict of string/value properties that will be passed - to the ErrorY constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.ErrorY` + - A dict of string/value properties that will be passed to the ErrorY constructor Returns ------- @@ -169,9 +169,9 @@ def error_z(self): """ The 'error_z' property is an instance of ErrorZ that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.ErrorZ` - - A dict of string/value properties that will be passed - to the ErrorZ constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.ErrorZ` + - A dict of string/value properties that will be passed to the ErrorZ constructor Returns ------- @@ -192,10 +192,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -231,9 +232,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -273,9 +274,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -316,9 +320,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -418,8 +425,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -436,9 +445,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -464,7 +473,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -483,7 +492,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -500,9 +510,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -519,9 +529,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -589,7 +599,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -610,8 +621,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -629,7 +642,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -646,9 +660,9 @@ def projection(self): """ The 'projection' property is an instance of Projection that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Projection` - - A dict of string/value properties that will be passed - to the Projection constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Projection` + - A dict of string/value properties that will be passed to the Projection constructor Returns ------- @@ -707,9 +721,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -729,8 +743,10 @@ def surfaceaxis(self): 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] + + - One of the following enumeration values: + + [-1, 0, 1, 2] Returns ------- @@ -748,11 +764,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -775,9 +792,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -796,9 +816,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -817,11 +837,14 @@ def textposition(self): (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 + + - 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 ------- @@ -887,9 +910,12 @@ def texttemplate(self): point (the ones that are `arrayOk: true`) are available. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -927,8 +953,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -979,8 +1007,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1016,11 +1046,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1048,8 +1080,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1103,11 +1137,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1135,8 +1171,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1190,11 +1228,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1222,8 +1262,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_scattercarpet.py b/plotly/graph_objects/_scattercarpet.py index edb3eea98b..0ac6cee378 100644 --- a/plotly/graph_objects/_scattercarpet.py +++ b/plotly/graph_objects/_scattercarpet.py @@ -142,8 +142,10 @@ def carpet(self): lie The 'carpet' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -228,8 +230,10 @@ def fill(self): the other. The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] + + - One of the following enumeration values: + + ['none', 'toself', 'tonext'] Returns ------- @@ -249,11 +253,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -274,10 +279,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['a', 'b', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -313,9 +319,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -337,7 +343,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters + + - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns @@ -378,9 +385,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -421,9 +431,12 @@ def hovertext(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -523,8 +536,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -541,9 +556,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -569,7 +584,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -588,7 +603,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -605,9 +621,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -624,9 +640,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -694,7 +710,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -715,8 +732,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -734,7 +753,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -751,9 +771,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -811,9 +831,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -836,9 +856,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -857,9 +880,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -878,11 +901,14 @@ def textposition(self): (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 + + - 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 ------- @@ -950,9 +976,12 @@ def texttemplate(self): and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -990,8 +1019,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1039,9 +1070,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1061,8 +1092,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1128,7 +1161,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_scattergeo.py b/plotly/graph_objects/_scattergeo.py index 4e6b0bb463..a706681b6c 100644 --- a/plotly/graph_objects/_scattergeo.py +++ b/plotly/graph_objects/_scattergeo.py @@ -131,8 +131,10 @@ def featureidkey(self): "properties.name". The 'featureidkey' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -152,8 +154,10 @@ def fill(self): 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'] + + - One of the following enumeration values: + + ['none', 'toself'] Returns ------- @@ -173,11 +177,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -243,10 +248,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -282,9 +288,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -324,9 +330,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -368,9 +377,12 @@ def hovertext(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -506,8 +518,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -524,9 +538,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -552,7 +566,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -571,7 +585,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -588,9 +603,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -612,8 +627,10 @@ def locationmode(self): GeoJSON linked to the `geojson` attribute. The 'locationmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['ISO-3', 'USA-states', 'country names', 'geojson-id'] + + - One of the following enumeration values: + + ['ISO-3', 'USA-states', 'country names', 'geojson-id'] Returns ------- @@ -705,9 +722,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -775,7 +792,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -796,8 +814,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -815,7 +835,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -832,9 +853,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -892,9 +913,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -918,9 +939,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -939,9 +963,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -960,11 +984,14 @@ def textposition(self): (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 + + - 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 ------- @@ -1032,9 +1059,12 @@ def texttemplate(self): `lon`, `location` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1072,8 +1102,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1121,9 +1153,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1143,8 +1175,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scattergl.py b/plotly/graph_objects/_scattergl.py index 21ca09656a..64d1794b74 100644 --- a/plotly/graph_objects/_scattergl.py +++ b/plotly/graph_objects/_scattergl.py @@ -141,7 +141,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -160,7 +160,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -177,9 +177,9 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.ErrorX` - - A dict of string/value properties that will be passed - to the ErrorX constructor + + - An instance of :class:`plotly.graph_objects.scattergl.ErrorX` + - A dict of string/value properties that will be passed to the ErrorX constructor Returns ------- @@ -196,9 +196,9 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.ErrorY` - - A dict of string/value properties that will be passed - to the ErrorY constructor + + - An instance of :class:`plotly.graph_objects.scattergl.ErrorY` + - A dict of string/value properties that will be passed to the ErrorY constructor Returns ------- @@ -234,9 +234,11 @@ def fill(self): 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'] + + - One of the following enumeration values: + + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', 'toself', + 'tonext'] Returns ------- @@ -256,11 +258,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -281,10 +284,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -320,9 +324,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -362,9 +366,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -405,9 +412,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -507,8 +517,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -525,9 +537,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -553,7 +565,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -572,7 +584,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -589,9 +602,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -608,9 +621,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -673,7 +686,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -694,8 +708,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -713,7 +729,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -730,9 +747,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -790,9 +807,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -815,9 +832,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -836,9 +856,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -857,11 +877,14 @@ def textposition(self): (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 + + - 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 ------- @@ -927,9 +950,12 @@ def texttemplate(self): point (the ones that are `arrayOk: true`) are available. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -967,8 +993,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1016,9 +1044,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scattergl.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1038,8 +1066,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1117,11 +1147,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1149,8 +1181,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1210,8 +1244,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1307,11 +1343,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1339,8 +1377,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1400,8 +1440,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- diff --git a/plotly/graph_objects/_scattermap.py b/plotly/graph_objects/_scattermap.py index d8e84e6d66..bcadad03cd 100644 --- a/plotly/graph_objects/_scattermap.py +++ b/plotly/graph_objects/_scattermap.py @@ -68,8 +68,10 @@ def below(self): scattermap layers above every other layer, set `below` to "''". The 'below' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -86,9 +88,9 @@ def cluster(self): """ The 'cluster' property is an instance of Cluster that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Cluster` - - A dict of string/value properties that will be passed - to the Cluster constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Cluster` + - A dict of string/value properties that will be passed to the Cluster constructor Returns ------- @@ -167,8 +169,10 @@ def fill(self): 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'] + + - One of the following enumeration values: + + ['none', 'toself'] Returns ------- @@ -188,11 +192,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -213,10 +218,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -252,9 +258,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -294,9 +300,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -337,9 +346,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -475,8 +487,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -493,9 +507,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -521,7 +535,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -540,7 +554,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -557,9 +572,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -612,9 +627,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -680,7 +695,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -701,8 +717,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -720,7 +738,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -737,9 +756,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -797,9 +816,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -845,9 +864,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -868,9 +890,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -889,10 +911,12 @@ def textposition(self): (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'] + + - 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 ------- @@ -941,9 +965,12 @@ def texttemplate(self): `lon` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -981,8 +1008,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1030,9 +1059,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scattermap.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1052,8 +1081,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scattermapbox.py b/plotly/graph_objects/_scattermapbox.py index 60e16ffc62..fb65779dbb 100644 --- a/plotly/graph_objects/_scattermapbox.py +++ b/plotly/graph_objects/_scattermapbox.py @@ -70,8 +70,10 @@ def below(self): `below` to "''". The 'below' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -88,9 +90,9 @@ def cluster(self): """ The 'cluster' property is an instance of Cluster that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Cluster` - - A dict of string/value properties that will be passed - to the Cluster constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Cluster` + - A dict of string/value properties that will be passed to the Cluster constructor Returns ------- @@ -169,8 +171,10 @@ def fill(self): 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'] + + - One of the following enumeration values: + + ['none', 'toself'] Returns ------- @@ -190,11 +194,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -215,10 +220,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -254,9 +260,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -296,9 +302,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -339,9 +348,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -477,8 +489,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -495,9 +509,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -523,7 +537,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -542,7 +556,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -559,9 +574,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -614,9 +629,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -682,7 +697,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -703,8 +719,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -722,7 +740,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -739,9 +758,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -799,9 +818,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -851,9 +870,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -874,9 +896,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -895,10 +917,12 @@ def textposition(self): (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'] + + - 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 ------- @@ -947,9 +971,12 @@ def texttemplate(self): `lon` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -987,8 +1014,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1036,9 +1065,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1058,8 +1087,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scatterpolar.py b/plotly/graph_objects/_scatterpolar.py index 8480e10d02..b3610e51dc 100644 --- a/plotly/graph_objects/_scatterpolar.py +++ b/plotly/graph_objects/_scatterpolar.py @@ -152,7 +152,7 @@ def dr(self): The 'dr' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -173,7 +173,7 @@ def dtheta(self): The 'dtheta' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -199,8 +199,10 @@ def fill(self): the other. The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] + + - One of the following enumeration values: + + ['none', 'toself', 'tonext'] Returns ------- @@ -220,11 +222,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -245,10 +248,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -284,9 +288,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -308,7 +312,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters + + - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns @@ -349,9 +354,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -392,9 +400,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -494,8 +505,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -512,9 +525,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -540,7 +553,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -559,7 +572,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -576,9 +590,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -595,9 +609,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -665,7 +679,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -686,8 +701,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -705,7 +722,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -777,9 +795,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -837,9 +855,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -885,9 +903,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -906,9 +927,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -927,11 +948,14 @@ def textposition(self): (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 + + - 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 ------- @@ -999,9 +1023,12 @@ def texttemplate(self): `theta` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1094,8 +1121,10 @@ def thetaunit(self): on "linear" angular axes. The 'thetaunit' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['radians', 'degrees', 'gradians'] + + - One of the following enumeration values: + + ['radians', 'degrees', 'gradians'] Returns ------- @@ -1114,8 +1143,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1163,9 +1194,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1185,8 +1216,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scatterpolargl.py b/plotly/graph_objects/_scatterpolargl.py index 38f7bf04f5..44fe5975e5 100644 --- a/plotly/graph_objects/_scatterpolargl.py +++ b/plotly/graph_objects/_scatterpolargl.py @@ -129,7 +129,7 @@ def dr(self): The 'dr' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -150,7 +150,7 @@ def dtheta(self): The 'dtheta' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -186,9 +186,11 @@ def fill(self): 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'] + + - One of the following enumeration values: + + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', 'toself', + 'tonext'] Returns ------- @@ -208,11 +210,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -233,10 +236,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters + + - 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 + - A list or array of the above Returns ------- @@ -272,9 +276,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -314,9 +318,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -357,9 +364,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -459,8 +469,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -477,9 +489,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -505,7 +517,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -524,7 +536,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -541,9 +554,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -560,9 +573,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -630,7 +643,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -651,8 +665,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -670,7 +686,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -742,9 +759,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -802,9 +819,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -850,9 +867,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -871,9 +891,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -892,11 +912,14 @@ def textposition(self): (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 + + - 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 ------- @@ -964,9 +987,12 @@ def texttemplate(self): `theta` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1059,8 +1085,10 @@ def thetaunit(self): on "linear" angular axes. The 'thetaunit' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['radians', 'degrees', 'gradians'] + + - One of the following enumeration values: + + ['radians', 'degrees', 'gradians'] Returns ------- @@ -1079,8 +1107,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1128,9 +1158,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1150,8 +1180,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scattersmith.py b/plotly/graph_objects/_scattersmith.py index 18af610385..fc56619856 100644 --- a/plotly/graph_objects/_scattersmith.py +++ b/plotly/graph_objects/_scattersmith.py @@ -154,8 +154,10 @@ def fill(self): the other. The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] + + - One of the following enumeration values: + + ['none', 'toself', 'tonext'] Returns ------- @@ -175,11 +177,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -200,10 +203,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['real', 'imag', 'text', 'name'] joined with '+' characters + + - Any combination of ['real', 'imag', 'text', 'name'] joined with '+' characters (e.g. 'real+imag') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -239,9 +243,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -263,7 +267,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters + + - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns @@ -304,9 +309,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -347,9 +355,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -487,8 +498,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -505,9 +518,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -533,7 +546,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -552,7 +565,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -569,9 +583,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -588,9 +602,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -658,7 +672,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -679,8 +694,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -698,7 +715,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -752,9 +770,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -812,9 +830,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -860,9 +878,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -881,9 +902,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -902,11 +923,14 @@ def textposition(self): (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 + + - 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 ------- @@ -974,9 +998,12 @@ def texttemplate(self): `imag` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1014,8 +1041,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1063,9 +1092,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1085,8 +1114,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_scatterternary.py b/plotly/graph_objects/_scatterternary.py index b7275e1cb1..eeee196e23 100644 --- a/plotly/graph_objects/_scatterternary.py +++ b/plotly/graph_objects/_scatterternary.py @@ -274,8 +274,10 @@ def fill(self): the other. The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] + + - One of the following enumeration values: + + ['none', 'toself', 'tonext'] Returns ------- @@ -295,11 +297,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -320,10 +323,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -359,9 +363,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -383,7 +387,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters + + - Any combination of ['points', 'fills'] joined with '+' characters (e.g. 'points+fills') Returns @@ -424,9 +429,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -467,9 +475,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -569,8 +580,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -587,9 +600,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -615,7 +628,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -634,7 +647,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -651,9 +665,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -670,9 +684,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -740,7 +754,8 @@ def mode(self): The 'mode' property is a flaglist and may be specified as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters (e.g. 'lines+markers') OR exactly one of ['none'] (e.g. 'none') @@ -761,8 +776,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -780,7 +797,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -797,9 +815,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -857,9 +875,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -904,7 +922,8 @@ def sum(self): ternary.sum The 'sum' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -927,9 +946,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -948,9 +970,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -969,11 +991,14 @@ def textposition(self): (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 + + - 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 ------- @@ -1041,9 +1066,12 @@ def texttemplate(self): `c` and `text`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1081,8 +1109,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1130,9 +1160,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1152,8 +1182,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_splom.py b/plotly/graph_objects/_splom.py index 5c7cf0ef51..039e9a9644 100644 --- a/plotly/graph_objects/_splom.py +++ b/plotly/graph_objects/_splom.py @@ -97,9 +97,9 @@ def diagonal(self): """ The 'diagonal' property is an instance of Diagonal that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Diagonal` - - A dict of string/value properties that will be passed - to the Diagonal constructor + + - An instance of :class:`plotly.graph_objects.splom.Diagonal` + - A dict of string/value properties that will be passed to the Diagonal constructor Returns ------- @@ -116,8 +116,9 @@ 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_objects.splom.Dimension - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.splom.Dimension + - A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor Returns @@ -139,9 +140,9 @@ def dimensiondefaults(self): The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Dimension` - - A dict of string/value properties that will be passed - to the Dimension constructor + + - An instance of :class:`plotly.graph_objects.splom.Dimension` + - A dict of string/value properties that will be passed to the Dimension constructor Returns ------- @@ -162,10 +163,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -201,9 +203,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.splom.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -243,9 +245,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -282,9 +287,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -384,8 +392,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -402,9 +412,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.splom.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -430,7 +440,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -449,7 +459,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -466,9 +477,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.splom.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -531,8 +542,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -550,7 +563,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -567,9 +581,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.splom.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -665,9 +679,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.splom.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -688,9 +702,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -727,8 +744,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -776,9 +795,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.splom.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -798,8 +817,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -822,11 +843,13 @@ def xaxes(self): 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.) + + 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 ------- @@ -854,8 +877,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -878,11 +903,13 @@ def yaxes(self): 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.) + + 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 ------- @@ -910,8 +937,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_streamtube.py b/plotly/graph_objects/_streamtube.py index f2397389a2..cc70aa4418 100644 --- a/plotly/graph_objects/_streamtube.py +++ b/plotly/graph_objects/_streamtube.py @@ -124,7 +124,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -146,7 +146,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -167,7 +167,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -209,9 +209,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.streamtube.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -239,30 +239,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -323,10 +324,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -362,9 +364,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.streamtube.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -407,9 +409,12 @@ def hovertemplate(self): ``. 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -446,8 +451,10 @@ 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 string + + - A number that will be converted to a string Returns ------- @@ -528,8 +535,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -546,9 +555,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.streamtube.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -574,7 +583,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -593,7 +602,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -610,9 +620,9 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.Lighting` - - A dict of string/value properties that will be passed - to the Lighting constructor + + - An instance of :class:`plotly.graph_objects.streamtube.Lighting` + - A dict of string/value properties that will be passed to the Lighting constructor Returns ------- @@ -629,9 +639,9 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.Lightposition` - - A dict of string/value properties that will be passed - to the Lightposition constructor + + - An instance of :class:`plotly.graph_objects.streamtube.Lightposition` + - A dict of string/value properties that will be passed to the Lightposition constructor Returns ------- @@ -649,7 +659,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -713,8 +724,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -737,7 +750,8 @@ def opacity(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -838,7 +852,8 @@ def sizeref(self): starting positions. The 'sizeref' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -855,9 +870,9 @@ def starts(self): """ The 'starts' property is an instance of Starts that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.Starts` - - A dict of string/value properties that will be passed - to the Starts constructor + + - An instance of :class:`plotly.graph_objects.streamtube.Starts` + - A dict of string/value properties that will be passed to the Starts constructor Returns ------- @@ -874,9 +889,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.streamtube.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -897,8 +912,10 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -938,8 +955,10 @@ def uhoverformat(self): default the values are formatted using generic number format. The 'uhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -958,8 +977,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1048,8 +1069,10 @@ def vhoverformat(self): default the values are formatted using generic number format. The 'vhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1069,8 +1092,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1128,8 +1153,10 @@ def whoverformat(self): default the values are formatted using generic number format. The 'whoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1193,8 +1220,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1258,8 +1287,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1323,8 +1354,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_sunburst.py b/plotly/graph_objects/_sunburst.py index 564eac7460..5012458222 100644 --- a/plotly/graph_objects/_sunburst.py +++ b/plotly/graph_objects/_sunburst.py @@ -71,8 +71,10 @@ def branchvalues(self): leaves. The 'branchvalues' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['remainder', 'total'] + + - One of the following enumeration values: + + ['remainder', 'total'] Returns ------- @@ -93,7 +95,8 @@ def count(self): The 'count' property is a flaglist and may be specified as a string containing: - - Any combination of ['branches', 'leaves'] joined with '+' characters + + - Any combination of ['branches', 'leaves'] joined with '+' characters (e.g. 'branches+leaves') Returns @@ -151,9 +154,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -174,10 +177,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -213,9 +217,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -258,9 +262,12 @@ def hovertemplate(self): ``. 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -301,9 +308,12 @@ def hovertext(self): "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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -379,9 +389,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -406,8 +416,10 @@ def insidetextorientation(self): to the radius of the sector. The 'insidetextorientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['horizontal', 'radial', 'tangential', 'auto'] + + - One of the following enumeration values: + + ['horizontal', 'radial', 'tangential', 'auto'] Returns ------- @@ -460,9 +472,9 @@ def leaf(self): """ The 'leaf' property is an instance of Leaf that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Leaf` - - A dict of string/value properties that will be passed - to the Leaf constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Leaf` + - A dict of string/value properties that will be passed to the Leaf constructor Returns ------- @@ -502,9 +514,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -530,7 +542,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -549,7 +561,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -586,9 +599,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -607,7 +620,8 @@ def maxdepth(self): `maxdepth` to "-1" to render all the levels in the hierarchy. The 'maxdepth' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -670,8 +684,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -689,7 +705,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -712,9 +729,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -772,9 +789,9 @@ def root(self): """ The 'root' property is an instance of Root that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Root` - - A dict of string/value properties that will be passed - to the Root constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Root` + - A dict of string/value properties that will be passed to the Root constructor Returns ------- @@ -831,9 +848,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -874,9 +891,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.sunburst.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -895,7 +912,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -947,9 +965,12 @@ def texttemplate(self): `percentParent`, `label` and `value`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -987,8 +1008,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1076,8 +1099,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_surface.py b/plotly/graph_objects/_surface.py index 78281708d1..56858f6fd2 100644 --- a/plotly/graph_objects/_surface.py +++ b/plotly/graph_objects/_surface.py @@ -123,7 +123,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -145,7 +145,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -166,7 +166,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -208,9 +208,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.surface.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -238,30 +238,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -297,9 +298,9 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.Contours` - - A dict of string/value properties that will be passed - to the Contours constructor + + - An instance of :class:`plotly.graph_objects.surface.Contours` + - A dict of string/value properties that will be passed to the Contours constructor Returns ------- @@ -380,10 +381,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -419,9 +421,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.surface.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -461,9 +463,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -500,9 +505,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -602,8 +610,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -620,9 +630,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.surface.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -648,7 +658,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -667,7 +677,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -684,9 +695,9 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.Lighting` - - A dict of string/value properties that will be passed - to the Lighting constructor + + - An instance of :class:`plotly.graph_objects.surface.Lighting` + - A dict of string/value properties that will be passed to the Lighting constructor Returns ------- @@ -703,9 +714,9 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.Lightposition` - - A dict of string/value properties that will be passed - to the Lightposition constructor + + - An instance of :class:`plotly.graph_objects.surface.Lightposition` + - A dict of string/value properties that will be passed to the Lightposition constructor Returns ------- @@ -768,8 +779,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -792,7 +805,8 @@ def opacity(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -915,9 +929,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.surface.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -975,9 +989,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1014,8 +1031,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1066,8 +1085,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1103,11 +1124,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1135,8 +1158,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1190,11 +1215,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1222,8 +1249,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1277,11 +1306,13 @@ 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: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -1309,8 +1340,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_table.py b/plotly/graph_objects/_table.py index 4ce577b68d..0479e8b05b 100644 --- a/plotly/graph_objects/_table.py +++ b/plotly/graph_objects/_table.py @@ -42,9 +42,9 @@ def cells(self): """ The 'cells' property is an instance of Cells that may be specified as: - - An instance of :class:`plotly.graph_objects.table.Cells` - - A dict of string/value properties that will be passed - to the Cells constructor + + - An instance of :class:`plotly.graph_objects.table.Cells` + - A dict of string/value properties that will be passed to the Cells constructor Returns ------- @@ -104,8 +104,9 @@ def columnwidth(self): 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 + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -181,9 +182,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.table.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.table.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -200,9 +201,9 @@ def header(self): """ The 'header' property is an instance of Header that may be specified as: - - An instance of :class:`plotly.graph_objects.table.Header` - - A dict of string/value properties that will be passed - to the Header constructor + + - An instance of :class:`plotly.graph_objects.table.Header` + - A dict of string/value properties that will be passed to the Header constructor Returns ------- @@ -223,10 +224,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -262,9 +264,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.table.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.table.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -342,9 +344,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.table.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.table.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -370,7 +372,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -389,7 +391,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -452,8 +455,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -470,9 +475,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.table.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.table.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -491,8 +496,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -543,8 +550,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_treemap.py b/plotly/graph_objects/_treemap.py index d78689cc79..631f743e22 100644 --- a/plotly/graph_objects/_treemap.py +++ b/plotly/graph_objects/_treemap.py @@ -71,8 +71,10 @@ def branchvalues(self): leaves. The 'branchvalues' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['remainder', 'total'] + + - One of the following enumeration values: + + ['remainder', 'total'] Returns ------- @@ -93,7 +95,8 @@ def count(self): The 'count' property is a flaglist and may be specified as a string containing: - - Any combination of ['branches', 'leaves'] joined with '+' characters + + - Any combination of ['branches', 'leaves'] joined with '+' characters (e.g. 'branches+leaves') Returns @@ -151,9 +154,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.treemap.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -174,10 +177,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -213,9 +217,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.treemap.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -258,9 +262,12 @@ def hovertemplate(self): ``. 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -301,9 +308,12 @@ def hovertext(self): "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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -379,9 +389,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.treemap.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -457,9 +467,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.treemap.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -485,7 +495,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -504,7 +514,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -541,9 +552,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.treemap.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -562,7 +573,8 @@ def maxdepth(self): `maxdepth` to "-1" to render all the levels in the hierarchy. The 'maxdepth' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -625,8 +637,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -644,7 +658,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -667,9 +682,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.treemap.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -727,9 +742,9 @@ def pathbar(self): """ The 'pathbar' property is an instance of Pathbar that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Pathbar` - - A dict of string/value properties that will be passed - to the Pathbar constructor + + - An instance of :class:`plotly.graph_objects.treemap.Pathbar` + - A dict of string/value properties that will be passed to the Pathbar constructor Returns ------- @@ -746,9 +761,9 @@ def root(self): """ The 'root' property is an instance of Root that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Root` - - A dict of string/value properties that will be passed - to the Root constructor + + - An instance of :class:`plotly.graph_objects.treemap.Root` + - A dict of string/value properties that will be passed to the Root constructor Returns ------- @@ -784,9 +799,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.treemap.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -827,9 +842,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.treemap.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -848,7 +863,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + + - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -868,10 +884,12 @@ def textposition(self): Sets the positions of the `text` elements. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] + + - 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 ------- @@ -921,9 +939,12 @@ def texttemplate(self): `percentParent`, `label` and `value`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -959,9 +980,9 @@ def tiling(self): """ The 'tiling' property is an instance of Tiling that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.Tiling` - - A dict of string/value properties that will be passed - to the Tiling constructor + + - An instance of :class:`plotly.graph_objects.treemap.Tiling` + - A dict of string/value properties that will be passed to the Tiling constructor Returns ------- @@ -980,8 +1001,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1069,8 +1092,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/_violin.py b/plotly/graph_objects/_violin.py index 7cde37ba8f..c156052e8e 100644 --- a/plotly/graph_objects/_violin.py +++ b/plotly/graph_objects/_violin.py @@ -81,8 +81,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -102,7 +104,8 @@ def bandwidth(self): thumb. The 'bandwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -119,9 +122,9 @@ def box(self): """ The 'box' property is an instance of Box that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Box` - - A dict of string/value properties that will be passed - to the Box constructor + + - An instance of :class:`plotly.graph_objects.violin.Box` + - A dict of string/value properties that will be passed to the Box constructor Returns ------- @@ -181,11 +184,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -206,10 +210,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -245,9 +250,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.violin.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -268,7 +273,8 @@ def hoveron(self): The 'hoveron' property is a flaglist and may be specified as a string containing: - - Any combination of ['violins', 'points', 'kde'] joined with '+' characters + + - Any combination of ['violins', 'points', 'kde'] joined with '+' characters (e.g. 'violins+points') OR exactly one of ['all'] (e.g. 'all') @@ -310,9 +316,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -349,9 +358,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -429,7 +441,8 @@ def jitter(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -472,8 +485,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -490,9 +505,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.violin.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -518,7 +533,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -537,7 +552,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -554,9 +570,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.violin.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -573,9 +589,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.violin.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -592,9 +608,9 @@ def meanline(self): """ The 'meanline' property is an instance of Meanline that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Meanline` - - A dict of string/value properties that will be passed - to the Meanline constructor + + - An instance of :class:`plotly.graph_objects.violin.Meanline` + - A dict of string/value properties that will be passed to the Meanline constructor Returns ------- @@ -662,8 +678,10 @@ def name(self): details). The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -683,8 +701,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -702,7 +722,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -721,8 +742,10 @@ def orientation(self): 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -744,7 +767,8 @@ def pointpos(self): horizontal violins. The 'pointpos' property is a number and may be specified as: - - An int or float in the interval [-2, 2] + + - An int or float in the interval [-2, 2] Returns ------- @@ -769,8 +793,10 @@ def points(self): otherwise defaults to "outliers". The 'points' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'outliers', 'suspectedoutliers', False] + + - One of the following enumeration values: + + ['all', 'outliers', 'suspectedoutliers', False] Returns ------- @@ -799,8 +825,10 @@ def quartilemethod(self): upper half. The 'quartilemethod' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'exclusive', 'inclusive'] + + - One of the following enumeration values: + + ['linear', 'exclusive', 'inclusive'] Returns ------- @@ -823,8 +851,10 @@ def scalegroup(self): will be linked together The 'scalegroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -845,8 +875,10 @@ def scalemode(self): points making up each violin. The 'scalemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['width', 'count'] + + - One of the following enumeration values: + + ['width', 'count'] Returns ------- @@ -863,9 +895,9 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Selected` - - A dict of string/value properties that will be passed - to the Selected constructor + + - An instance of :class:`plotly.graph_objects.violin.Selected` + - A dict of string/value properties that will be passed to the Selected constructor Returns ------- @@ -927,8 +959,10 @@ def side(self): 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'] + + - One of the following enumeration values: + + ['both', 'positive', 'negative'] Returns ------- @@ -977,8 +1011,10 @@ def spanmode(self): attribute. The 'spanmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['soft', 'hard', 'manual'] + + - One of the following enumeration values: + + ['soft', 'hard', 'manual'] Returns ------- @@ -995,9 +1031,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.violin.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -1019,9 +1055,12 @@ def text(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1058,8 +1097,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1107,9 +1148,9 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.Unselected` - - A dict of string/value properties that will be passed - to the Unselected constructor + + - An instance of :class:`plotly.graph_objects.violin.Unselected` + - A dict of string/value properties that will be passed to the Unselected constructor Returns ------- @@ -1129,8 +1170,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1150,7 +1193,8 @@ def width(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1239,8 +1283,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1347,8 +1393,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1386,7 +1434,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/_volume.py b/plotly/graph_objects/_volume.py index c209602c95..b42a49c681 100644 --- a/plotly/graph_objects/_volume.py +++ b/plotly/graph_objects/_volume.py @@ -101,9 +101,9 @@ def caps(self): """ The 'caps' property is an instance of Caps that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Caps` - - A dict of string/value properties that will be passed - to the Caps constructor + + - An instance of :class:`plotly.graph_objects.volume.Caps` + - A dict of string/value properties that will be passed to the Caps constructor Returns ------- @@ -144,7 +144,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -165,7 +165,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -185,7 +185,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -227,9 +227,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.volume.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -257,30 +257,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -297,9 +298,9 @@ def contour(self): """ The 'contour' property is an instance of Contour that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Contour` - - A dict of string/value properties that will be passed - to the Contour constructor + + - An instance of :class:`plotly.graph_objects.volume.Contour` + - A dict of string/value properties that will be passed to the Contour constructor Returns ------- @@ -380,10 +381,11 @@ def hoverinfo(self): 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 + + - 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 + - A list or array of the above Returns ------- @@ -419,9 +421,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.volume.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -461,9 +463,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -500,9 +505,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -578,7 +586,7 @@ def isomax(self): The 'isomax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -597,7 +605,7 @@ def isomin(self): The 'isomin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -640,8 +648,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -658,9 +668,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.volume.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -686,7 +696,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -705,7 +715,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -722,9 +733,9 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Lighting` - - A dict of string/value properties that will be passed - to the Lighting constructor + + - An instance of :class:`plotly.graph_objects.volume.Lighting` + - A dict of string/value properties that will be passed to the Lighting constructor Returns ------- @@ -741,9 +752,9 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Lightposition` - - A dict of string/value properties that will be passed - to the Lightposition constructor + + - An instance of :class:`plotly.graph_objects.volume.Lightposition` + - A dict of string/value properties that will be passed to the Lightposition constructor Returns ------- @@ -806,8 +817,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -830,7 +843,8 @@ def opacity(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -953,9 +967,9 @@ def slices(self): """ The 'slices' property is an instance of Slices that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Slices` - - A dict of string/value properties that will be passed - to the Slices constructor + + - An instance of :class:`plotly.graph_objects.volume.Slices` + - A dict of string/value properties that will be passed to the Slices constructor Returns ------- @@ -972,9 +986,9 @@ def spaceframe(self): """ The 'spaceframe' property is an instance of Spaceframe that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Spaceframe` - - A dict of string/value properties that will be passed - to the Spaceframe constructor + + - An instance of :class:`plotly.graph_objects.volume.Spaceframe` + - A dict of string/value properties that will be passed to the Spaceframe constructor Returns ------- @@ -991,9 +1005,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.volume.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -1010,9 +1024,9 @@ def surface(self): """ The 'surface' property is an instance of Surface that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.Surface` - - A dict of string/value properties that will be passed - to the Surface constructor + + - An instance of :class:`plotly.graph_objects.volume.Surface` + - A dict of string/value properties that will be passed to the Surface constructor Returns ------- @@ -1032,9 +1046,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1071,8 +1088,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1143,8 +1162,10 @@ def valuehoverformat(self): default the values are formatted using generic number format. The 'valuehoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1182,8 +1203,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1229,8 +1252,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1294,8 +1319,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1359,8 +1386,10 @@ def zhoverformat(self): are formatted using `zaxis.hoverformat`. The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/_waterfall.py b/plotly/graph_objects/_waterfall.py index 47bb8633b9..de091dec4f 100644 --- a/plotly/graph_objects/_waterfall.py +++ b/plotly/graph_objects/_waterfall.py @@ -93,8 +93,10 @@ def alignmentgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -113,7 +115,7 @@ def base(self): The 'base' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -151,9 +153,9 @@ def connector(self): """ The 'connector' property is an instance of Connector that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Connector` - - A dict of string/value properties that will be passed - to the Connector constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Connector` + - A dict of string/value properties that will be passed to the Connector constructor Returns ------- @@ -172,8 +174,10 @@ def constraintext(self): 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'] + + - One of the following enumeration values: + + ['inside', 'outside', 'both', 'none'] Returns ------- @@ -230,9 +234,9 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Decreasing` - - A dict of string/value properties that will be passed - to the Decreasing constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Decreasing` + - A dict of string/value properties that will be passed to the Decreasing constructor Returns ------- @@ -251,7 +255,7 @@ def dx(self): The 'dx' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -270,7 +274,7 @@ def dy(self): The 'dy' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -291,10 +295,11 @@ def hoverinfo(self): The 'hoverinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters + + - Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters (e.g. 'name+x') OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above + - A list or array of the above Returns ------- @@ -330,9 +335,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -374,9 +379,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -417,9 +425,12 @@ def hovertext(self): `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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -493,9 +504,9 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Increasing` - - A dict of string/value properties that will be passed - to the Increasing constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Increasing` + - A dict of string/value properties that will be passed to the Increasing constructor Returns ------- @@ -514,8 +525,10 @@ def insidetextanchor(self): `textposition` "inside" mode. The 'insidetextanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['end', 'middle', 'start'] + + - One of the following enumeration values: + + ['end', 'middle', 'start'] Returns ------- @@ -534,9 +547,9 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Insidetextfont` - - A dict of string/value properties that will be passed - to the Insidetextfont constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Insidetextfont` + - A dict of string/value properties that will be passed to the Insidetextfont constructor Returns ------- @@ -579,8 +592,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -597,9 +612,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -625,7 +640,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -644,7 +659,8 @@ def legendwidth(self): trace. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -747,8 +763,10 @@ def name(self): and on hover. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -769,8 +787,9 @@ def offset(self): 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 + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -790,8 +809,10 @@ def offsetgroup(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -827,7 +848,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -846,8 +868,10 @@ def orientation(self): 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -866,9 +890,9 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Outsidetextfont` - - A dict of string/value properties that will be passed - to the Outsidetextfont constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Outsidetextfont` + - A dict of string/value properties that will be passed to the Outsidetextfont constructor Returns ------- @@ -926,9 +950,9 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Stream` - - A dict of string/value properties that will be passed - to the Stream constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Stream` + - A dict of string/value properties that will be passed to the Stream constructor Returns ------- @@ -951,9 +975,12 @@ def text(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -995,9 +1022,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -1018,7 +1045,8 @@ def textinfo(self): The 'textinfo' property is a flaglist and may be specified as a string containing: - - Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters + + - Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters (e.g. 'label+text') OR exactly one of ['none'] (e.g. 'none') @@ -1045,9 +1073,12 @@ def textposition(self): text appears. The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['inside', 'outside', 'auto', 'none'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['inside', 'outside', 'auto', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1115,9 +1146,12 @@ def texttemplate(self): `delta`, `final` and `label`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1153,9 +1187,9 @@ def totals(self): """ The 'totals' property is an instance of Totals that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.Totals` - - A dict of string/value properties that will be passed - to the Totals constructor + + - An instance of :class:`plotly.graph_objects.waterfall.Totals` + - A dict of string/value properties that will be passed to the Totals constructor Returns ------- @@ -1174,8 +1208,10 @@ def uid(self): constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1226,8 +1262,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -1245,8 +1283,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -1352,8 +1392,10 @@ def xhoverformat(self): are formatted using `xaxis.hoverformat`. The 'xhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1413,8 +1455,10 @@ def xperiodalignment(self): alignment of data points on the x axis. The 'xperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1520,8 +1564,10 @@ def yhoverformat(self): are formatted using `yaxis.hoverformat`. The 'yhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -1581,8 +1627,10 @@ def yperiodalignment(self): alignment of data points on the y axis. The 'yperiodalignment' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['start', 'middle', 'end'] + + - One of the following enumeration values: + + ['start', 'middle', 'end'] Returns ------- @@ -1620,7 +1668,8 @@ def zorder(self): `zorder` appear in front of those with lower `zorder`. The 'zorder' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- diff --git a/plotly/graph_objects/bar/_error_x.py b/plotly/graph_objects/bar/_error_x.py index 8884d01ea2..a666025439 100644 --- a/plotly/graph_objects/bar/_error_x.py +++ b/plotly/graph_objects/bar/_error_x.py @@ -108,11 +108,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -166,7 +167,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -182,7 +184,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -199,7 +202,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -224,8 +228,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -245,7 +251,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -266,7 +273,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,7 +311,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/bar/_error_y.py b/plotly/graph_objects/bar/_error_y.py index 78d86ba279..3f3aaefa38 100644 --- a/plotly/graph_objects/bar/_error_y.py +++ b/plotly/graph_objects/bar/_error_y.py @@ -107,11 +107,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -149,7 +150,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -165,7 +167,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -182,7 +185,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -207,8 +211,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -228,7 +234,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -249,7 +256,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -286,7 +294,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/bar/_hoverlabel.py b/plotly/graph_objects/bar/_hoverlabel.py index abdcaac63d..fe40bfddc3 100644 --- a/plotly/graph_objects/bar/_hoverlabel.py +++ b/plotly/graph_objects/bar/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.bar.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/bar/_insidetextfont.py b/plotly/graph_objects/bar/_insidetextfont.py index 574a60d82b..793f4620bf 100644 --- a/plotly/graph_objects/bar/_insidetextfont.py +++ b/plotly/graph_objects/bar/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/bar/_legendgrouptitle.py b/plotly/graph_objects/bar/_legendgrouptitle.py index 959ee7cd9a..4be7128c2c 100644 --- a/plotly/graph_objects/bar/_legendgrouptitle.py +++ b/plotly/graph_objects/bar/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.bar.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/bar/_marker.py b/plotly/graph_objects/bar/_marker.py index cb3f34ea75..93117c8a85 100644 --- a/plotly/graph_objects/bar/_marker.py +++ b/plotly/graph_objects/bar/_marker.py @@ -85,7 +85,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -108,7 +108,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -130,7 +130,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -151,14 +151,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to bar.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to bar.marker.colorscale + - A list or array of any of the above Returns ------- @@ -200,9 +200,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -231,30 +231,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -310,9 +311,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -330,8 +331,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -368,9 +371,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/bar/_outsidetextfont.py b/plotly/graph_objects/bar/_outsidetextfont.py index b63b2300a0..02add377ef 100644 --- a/plotly/graph_objects/bar/_outsidetextfont.py +++ b/plotly/graph_objects/bar/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/bar/_selected.py b/plotly/graph_objects/bar/_selected.py index 8caec26365..08767c0556 100644 --- a/plotly/graph_objects/bar/_selected.py +++ b/plotly/graph_objects/bar/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.bar.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.bar.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/bar/_stream.py b/plotly/graph_objects/bar/_stream.py index 0bfef39183..bd4f8cd94e 100644 --- a/plotly/graph_objects/bar/_stream.py +++ b/plotly/graph_objects/bar/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/bar/_textfont.py b/plotly/graph_objects/bar/_textfont.py index f924283ec2..4a6dc8e9f9 100644 --- a/plotly/graph_objects/bar/_textfont.py +++ b/plotly/graph_objects/bar/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/bar/_unselected.py b/plotly/graph_objects/bar/_unselected.py index 57bd826071..21a5b5d3e4 100644 --- a/plotly/graph_objects/bar/_unselected.py +++ b/plotly/graph_objects/bar/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.bar.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.bar.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/bar/hoverlabel/_font.py b/plotly/graph_objects/bar/hoverlabel/_font.py index 78c94a9b7c..eb259a81fa 100644 --- a/plotly/graph_objects/bar/hoverlabel/_font.py +++ b/plotly/graph_objects/bar/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/bar/legendgrouptitle/_font.py b/plotly/graph_objects/bar/legendgrouptitle/_font.py index dfcabd1007..6df6b0772d 100644 --- a/plotly/graph_objects/bar/legendgrouptitle/_font.py +++ b/plotly/graph_objects/bar/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/bar/marker/_colorbar.py b/plotly/graph_objects/bar/marker/_colorbar.py index e53090e1b6..5b7b86c9d6 100644 --- a/plotly/graph_objects/bar/marker/_colorbar.py +++ b/plotly/graph_objects/bar/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.bar.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.bar.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -632,9 +659,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -655,8 +682,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -676,10 +705,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -702,7 +733,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -721,7 +753,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -745,8 +778,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -764,8 +799,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -785,8 +822,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -804,8 +843,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -898,7 +939,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -915,9 +957,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -942,7 +984,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,8 +1005,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -982,7 +1026,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1002,8 +1047,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1028,7 +1075,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1049,8 +1096,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1068,7 +1117,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1088,8 +1138,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/bar/marker/_line.py b/plotly/graph_objects/bar/marker/_line.py index 44846e5569..d9c6431043 100644 --- a/plotly/graph_objects/bar/marker/_line.py +++ b/plotly/graph_objects/bar/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to bar.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/bar/marker/_pattern.py b/plotly/graph_objects/bar/marker/_pattern.py index a94aefebec..329bf96ff3 100644 --- a/plotly/graph_objects/bar/marker/_pattern.py +++ b/plotly/graph_objects/bar/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/bar/marker/colorbar/_tickfont.py b/plotly/graph_objects/bar/marker/colorbar/_tickfont.py index 329412e46a..84f42183ec 100644 --- a/plotly/graph_objects/bar/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/bar/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/bar/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/bar/marker/colorbar/_tickformatstop.py index 006987e3c6..c400a921b6 100644 --- a/plotly/graph_objects/bar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/bar/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/bar/marker/colorbar/_title.py b/plotly/graph_objects/bar/marker/colorbar/_title.py index 62f49e2748..cf34fa33d6 100644 --- a/plotly/graph_objects/bar/marker/colorbar/_title.py +++ b/plotly/graph_objects/bar/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.bar.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/bar/marker/colorbar/title/_font.py b/plotly/graph_objects/bar/marker/colorbar/title/_font.py index 51ac5cd79d..35684c6017 100644 --- a/plotly/graph_objects/bar/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/bar/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/bar/selected/_marker.py b/plotly/graph_objects/bar/selected/_marker.py index 72356f5b6d..1857cd6a8b 100644 --- a/plotly/graph_objects/bar/selected/_marker.py +++ b/plotly/graph_objects/bar/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/bar/selected/_textfont.py b/plotly/graph_objects/bar/selected/_textfont.py index 02344b2f4e..477ae8c491 100644 --- a/plotly/graph_objects/bar/selected/_textfont.py +++ b/plotly/graph_objects/bar/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/bar/unselected/_marker.py b/plotly/graph_objects/bar/unselected/_marker.py index 95e6746a07..f6c9c1d4ef 100644 --- a/plotly/graph_objects/bar/unselected/_marker.py +++ b/plotly/graph_objects/bar/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/bar/unselected/_textfont.py b/plotly/graph_objects/bar/unselected/_textfont.py index 27c3ab8d71..3e05b4bc8a 100644 --- a/plotly/graph_objects/bar/unselected/_textfont.py +++ b/plotly/graph_objects/bar/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/barpolar/_hoverlabel.py b/plotly/graph_objects/barpolar/_hoverlabel.py index 8fa6a6c9de..a3904e58f6 100644 --- a/plotly/graph_objects/barpolar/_hoverlabel.py +++ b/plotly/graph_objects/barpolar/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.barpolar.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/barpolar/_legendgrouptitle.py b/plotly/graph_objects/barpolar/_legendgrouptitle.py index a41850cfe2..c65008afb2 100644 --- a/plotly/graph_objects/barpolar/_legendgrouptitle.py +++ b/plotly/graph_objects/barpolar/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.barpolar.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/barpolar/_marker.py b/plotly/graph_objects/barpolar/_marker.py index 31f7a15d2d..119d94471f 100644 --- a/plotly/graph_objects/barpolar/_marker.py +++ b/plotly/graph_objects/barpolar/_marker.py @@ -84,7 +84,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -107,7 +107,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -129,7 +129,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -150,14 +150,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to barpolar.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to barpolar.marker.colorscale + - A list or array of any of the above Returns ------- @@ -199,9 +199,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -230,30 +230,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -288,9 +289,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -308,8 +309,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -346,9 +349,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/barpolar/_selected.py b/plotly/graph_objects/barpolar/_selected.py index 839bbcd6e7..6539412ed4 100644 --- a/plotly/graph_objects/barpolar/_selected.py +++ b/plotly/graph_objects/barpolar/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.barpolar.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.barpolar.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/barpolar/_stream.py b/plotly/graph_objects/barpolar/_stream.py index b12006d5c4..0f17e17acd 100644 --- a/plotly/graph_objects/barpolar/_stream.py +++ b/plotly/graph_objects/barpolar/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/barpolar/_unselected.py b/plotly/graph_objects/barpolar/_unselected.py index a356054623..3afa7fbad0 100644 --- a/plotly/graph_objects/barpolar/_unselected.py +++ b/plotly/graph_objects/barpolar/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.barpolar.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.barpolar.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/barpolar/hoverlabel/_font.py b/plotly/graph_objects/barpolar/hoverlabel/_font.py index d0ce2da1b7..08f6ad3540 100644 --- a/plotly/graph_objects/barpolar/hoverlabel/_font.py +++ b/plotly/graph_objects/barpolar/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/barpolar/legendgrouptitle/_font.py b/plotly/graph_objects/barpolar/legendgrouptitle/_font.py index 7ebe47080e..80046f2b64 100644 --- a/plotly/graph_objects/barpolar/legendgrouptitle/_font.py +++ b/plotly/graph_objects/barpolar/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/barpolar/marker/_colorbar.py b/plotly/graph_objects/barpolar/marker/_colorbar.py index 991d8c66ef..b857abe658 100644 --- a/plotly/graph_objects/barpolar/marker/_colorbar.py +++ b/plotly/graph_objects/barpolar/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.barpolar.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.barpolar.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/barpolar/marker/_line.py b/plotly/graph_objects/barpolar/marker/_line.py index dbef8e2b70..a405de4f55 100644 --- a/plotly/graph_objects/barpolar/marker/_line.py +++ b/plotly/graph_objects/barpolar/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to barpolar.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/barpolar/marker/_pattern.py b/plotly/graph_objects/barpolar/marker/_pattern.py index 7b6f34fe06..3c632efa5b 100644 --- a/plotly/graph_objects/barpolar/marker/_pattern.py +++ b/plotly/graph_objects/barpolar/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/barpolar/marker/colorbar/_tickfont.py b/plotly/graph_objects/barpolar/marker/colorbar/_tickfont.py index d66a931390..ddde9a6aa1 100644 --- a/plotly/graph_objects/barpolar/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/barpolar/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/barpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/barpolar/marker/colorbar/_tickformatstop.py index 7aca6c620b..335ff52e3a 100644 --- a/plotly/graph_objects/barpolar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/barpolar/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/barpolar/marker/colorbar/_title.py b/plotly/graph_objects/barpolar/marker/colorbar/_title.py index f8f68fb880..378f69524c 100644 --- a/plotly/graph_objects/barpolar/marker/colorbar/_title.py +++ b/plotly/graph_objects/barpolar/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.barpolar.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/barpolar/marker/colorbar/title/_font.py b/plotly/graph_objects/barpolar/marker/colorbar/title/_font.py index 6e92eeab83..702671104f 100644 --- a/plotly/graph_objects/barpolar/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/barpolar/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/barpolar/selected/_marker.py b/plotly/graph_objects/barpolar/selected/_marker.py index 8150a6dba4..403768ae7f 100644 --- a/plotly/graph_objects/barpolar/selected/_marker.py +++ b/plotly/graph_objects/barpolar/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/barpolar/selected/_textfont.py b/plotly/graph_objects/barpolar/selected/_textfont.py index 79192f8b34..480496963e 100644 --- a/plotly/graph_objects/barpolar/selected/_textfont.py +++ b/plotly/graph_objects/barpolar/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/barpolar/unselected/_marker.py b/plotly/graph_objects/barpolar/unselected/_marker.py index 11bc394ca5..57cb757492 100644 --- a/plotly/graph_objects/barpolar/unselected/_marker.py +++ b/plotly/graph_objects/barpolar/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/barpolar/unselected/_textfont.py b/plotly/graph_objects/barpolar/unselected/_textfont.py index 9a705cf6aa..18a9f22697 100644 --- a/plotly/graph_objects/barpolar/unselected/_textfont.py +++ b/plotly/graph_objects/barpolar/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/box/_hoverlabel.py b/plotly/graph_objects/box/_hoverlabel.py index b305523f0c..a3861966f6 100644 --- a/plotly/graph_objects/box/_hoverlabel.py +++ b/plotly/graph_objects/box/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.box.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.box.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/box/_legendgrouptitle.py b/plotly/graph_objects/box/_legendgrouptitle.py index 26b2c8a252..733e75f9c1 100644 --- a/plotly/graph_objects/box/_legendgrouptitle.py +++ b/plotly/graph_objects/box/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.box.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.box.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/box/_line.py b/plotly/graph_objects/box/_line.py index ea6f4667d2..04b3131448 100644 --- a/plotly/graph_objects/box/_line.py +++ b/plotly/graph_objects/box/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/box/_marker.py b/plotly/graph_objects/box/_marker.py index 2c82c744fd..0bef0ddad2 100644 --- a/plotly/graph_objects/box/_marker.py +++ b/plotly/graph_objects/box/_marker.py @@ -47,11 +47,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -68,9 +69,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.box.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.box.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -88,7 +89,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -106,11 +108,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -128,7 +131,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -149,96 +153,91 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] Returns ------- diff --git a/plotly/graph_objects/box/_selected.py b/plotly/graph_objects/box/_selected.py index f4715d439e..6b068e1e62 100644 --- a/plotly/graph_objects/box/_selected.py +++ b/plotly/graph_objects/box/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.box.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.box.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/box/_stream.py b/plotly/graph_objects/box/_stream.py index 1e15786c76..e36b70ca67 100644 --- a/plotly/graph_objects/box/_stream.py +++ b/plotly/graph_objects/box/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/box/_unselected.py b/plotly/graph_objects/box/_unselected.py index 9e6124b017..10d760168e 100644 --- a/plotly/graph_objects/box/_unselected.py +++ b/plotly/graph_objects/box/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.box.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.box.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/box/hoverlabel/_font.py b/plotly/graph_objects/box/hoverlabel/_font.py index ecf47360e2..d89ca15134 100644 --- a/plotly/graph_objects/box/hoverlabel/_font.py +++ b/plotly/graph_objects/box/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/box/legendgrouptitle/_font.py b/plotly/graph_objects/box/legendgrouptitle/_font.py index 3255714d3d..2f9a79ad8a 100644 --- a/plotly/graph_objects/box/legendgrouptitle/_font.py +++ b/plotly/graph_objects/box/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/box/marker/_line.py b/plotly/graph_objects/box/marker/_line.py index 90a07d7a3d..6df14af9b0 100644 --- a/plotly/graph_objects/box/marker/_line.py +++ b/plotly/graph_objects/box/marker/_line.py @@ -19,11 +19,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,11 +43,12 @@ def outliercolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -65,7 +67,8 @@ def outlierwidth(self): points. The 'outlierwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -83,7 +86,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/box/selected/_marker.py b/plotly/graph_objects/box/selected/_marker.py index 34d009cc98..305b680245 100644 --- a/plotly/graph_objects/box/selected/_marker.py +++ b/plotly/graph_objects/box/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/box/unselected/_marker.py b/plotly/graph_objects/box/unselected/_marker.py index 05cd68c4d2..e4f3a5684e 100644 --- a/plotly/graph_objects/box/unselected/_marker.py +++ b/plotly/graph_objects/box/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/candlestick/_decreasing.py b/plotly/graph_objects/candlestick/_decreasing.py index 593cb48dd3..3677fd8530 100644 --- a/plotly/graph_objects/candlestick/_decreasing.py +++ b/plotly/graph_objects/candlestick/_decreasing.py @@ -18,11 +18,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -39,9 +40,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.decreasing.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.candlestick.decreasing.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/candlestick/_hoverlabel.py b/plotly/graph_objects/candlestick/_hoverlabel.py index 6ff9169a1b..abcc2b06ba 100644 --- a/plotly/graph_objects/candlestick/_hoverlabel.py +++ b/plotly/graph_objects/candlestick/_hoverlabel.py @@ -29,9 +29,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -67,12 +70,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -108,12 +112,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -151,9 +156,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.candlestick.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -176,7 +181,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/candlestick/_increasing.py b/plotly/graph_objects/candlestick/_increasing.py index 9e715d7902..d38c168240 100644 --- a/plotly/graph_objects/candlestick/_increasing.py +++ b/plotly/graph_objects/candlestick/_increasing.py @@ -18,11 +18,12 @@ def fillcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -39,9 +40,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.increasing.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.candlestick.increasing.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/candlestick/_legendgrouptitle.py b/plotly/graph_objects/candlestick/_legendgrouptitle.py index 0c0c1a6c32..2eda59f38f 100644 --- a/plotly/graph_objects/candlestick/_legendgrouptitle.py +++ b/plotly/graph_objects/candlestick/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.candlestick.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.candlestick.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/candlestick/_line.py b/plotly/graph_objects/candlestick/_line.py index 8b08bd66db..82ce0eac90 100644 --- a/plotly/graph_objects/candlestick/_line.py +++ b/plotly/graph_objects/candlestick/_line.py @@ -18,7 +18,8 @@ def width(self): `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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/candlestick/_stream.py b/plotly/graph_objects/candlestick/_stream.py index 209ba8966e..712db3870c 100644 --- a/plotly/graph_objects/candlestick/_stream.py +++ b/plotly/graph_objects/candlestick/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/candlestick/decreasing/_line.py b/plotly/graph_objects/candlestick/decreasing/_line.py index a7ba10193f..b701eec308 100644 --- a/plotly/graph_objects/candlestick/decreasing/_line.py +++ b/plotly/graph_objects/candlestick/decreasing/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/candlestick/hoverlabel/_font.py b/plotly/graph_objects/candlestick/hoverlabel/_font.py index a08474b3e1..b274164c0e 100644 --- a/plotly/graph_objects/candlestick/hoverlabel/_font.py +++ b/plotly/graph_objects/candlestick/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/candlestick/increasing/_line.py b/plotly/graph_objects/candlestick/increasing/_line.py index 6f309d6538..eff4071af4 100644 --- a/plotly/graph_objects/candlestick/increasing/_line.py +++ b/plotly/graph_objects/candlestick/increasing/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/candlestick/legendgrouptitle/_font.py b/plotly/graph_objects/candlestick/legendgrouptitle/_font.py index 80a325855f..0985f5cef8 100644 --- a/plotly/graph_objects/candlestick/legendgrouptitle/_font.py +++ b/plotly/graph_objects/candlestick/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/carpet/_aaxis.py b/plotly/graph_objects/carpet/_aaxis.py index 3c6a25bcbf..7660eaa10f 100644 --- a/plotly/graph_objects/carpet/_aaxis.py +++ b/plotly/graph_objects/carpet/_aaxis.py @@ -75,7 +75,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -94,7 +95,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -115,8 +117,10 @@ def autorange(self): `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'] + + - One of the following enumeration values: + + [True, False, 'reversed'] Returns ------- @@ -137,8 +141,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -205,9 +211,11 @@ def categoryorder(self): `categoryarray`. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array'] Returns ------- @@ -223,8 +231,10 @@ def categoryorder(self, val): def cheatertype(self): """ The 'cheatertype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['index', 'value'] + + - One of the following enumeration values: + + ['index', 'value'] Returns ------- @@ -245,11 +255,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -267,7 +278,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -305,11 +317,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -328,7 +341,7 @@ def endlinewidth(self): The 'endlinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -350,8 +363,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -388,11 +403,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -413,10 +429,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -434,7 +454,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -477,7 +498,8 @@ 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) + + - An int (or float that will be cast to an int) Returns ------- @@ -495,8 +517,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -514,8 +538,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -533,11 +559,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -555,7 +582,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -573,7 +601,8 @@ def minexponent(self): Hide SI prefix for 10^n if |n| is below this number The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -591,11 +620,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -613,7 +643,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -635,10 +666,14 @@ def minorgriddash(self): "5px,10px,2px,2px"). The 'minorgriddash' 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.) + + - 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 ------- @@ -656,7 +691,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -677,7 +713,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -729,8 +766,10 @@ def rangemode(self): 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'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -769,8 +808,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -826,8 +867,10 @@ def showticklabels(self): 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'] + + - One of the following enumeration values: + + ['start', 'end', 'both', 'none'] Returns ------- @@ -848,8 +891,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -867,8 +912,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -884,7 +931,8 @@ def showticksuffix(self, val): def smoothing(self): """ The 'smoothing' property is a number and may be specified as: - - An int or float in the interval [0, 1.3] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -922,11 +970,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -945,7 +994,7 @@ def startlinewidth(self): The 'startlinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,7 +1012,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1004,9 +1054,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.aaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.carpet.aaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -1033,8 +1083,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1051,8 +1103,9 @@ 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_objects.carpet.aaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.carpet.aaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1075,9 +1128,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.aaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.carpet.aaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1093,8 +1146,10 @@ def tickformatstopdefaults(self, val): def tickmode(self): """ The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'array'] + + - One of the following enumeration values: + + ['linear', 'array'] Returns ------- @@ -1112,8 +1167,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1131,8 +1188,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1224,9 +1283,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.aaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.carpet.aaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1246,8 +1305,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'date', 'category'] Returns ------- diff --git a/plotly/graph_objects/carpet/_baxis.py b/plotly/graph_objects/carpet/_baxis.py index a5e6b3d433..dd60173363 100644 --- a/plotly/graph_objects/carpet/_baxis.py +++ b/plotly/graph_objects/carpet/_baxis.py @@ -75,7 +75,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -94,7 +95,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -115,8 +117,10 @@ def autorange(self): `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'] + + - One of the following enumeration values: + + [True, False, 'reversed'] Returns ------- @@ -137,8 +141,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -205,9 +211,11 @@ def categoryorder(self): `categoryarray`. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array'] Returns ------- @@ -223,8 +231,10 @@ def categoryorder(self, val): def cheatertype(self): """ The 'cheatertype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['index', 'value'] + + - One of the following enumeration values: + + ['index', 'value'] Returns ------- @@ -245,11 +255,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -267,7 +278,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -305,11 +317,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -328,7 +341,7 @@ def endlinewidth(self): The 'endlinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -350,8 +363,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -388,11 +403,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -413,10 +429,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -434,7 +454,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -477,7 +498,8 @@ 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) + + - An int (or float that will be cast to an int) Returns ------- @@ -495,8 +517,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -514,8 +538,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -533,11 +559,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -555,7 +582,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -573,7 +601,8 @@ def minexponent(self): Hide SI prefix for 10^n if |n| is below this number The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -591,11 +620,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -613,7 +643,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -635,10 +666,14 @@ def minorgriddash(self): "5px,10px,2px,2px"). The 'minorgriddash' 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.) + + - 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 ------- @@ -656,7 +691,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -677,7 +713,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -729,8 +766,10 @@ def rangemode(self): 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'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -769,8 +808,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -826,8 +867,10 @@ def showticklabels(self): 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'] + + - One of the following enumeration values: + + ['start', 'end', 'both', 'none'] Returns ------- @@ -848,8 +891,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -867,8 +912,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -884,7 +931,8 @@ def showticksuffix(self, val): def smoothing(self): """ The 'smoothing' property is a number and may be specified as: - - An int or float in the interval [0, 1.3] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -922,11 +970,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -945,7 +994,7 @@ def startlinewidth(self): The 'startlinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,7 +1012,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1004,9 +1054,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.baxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.carpet.baxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -1033,8 +1083,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1051,8 +1103,9 @@ 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_objects.carpet.baxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.carpet.baxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1075,9 +1128,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.baxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.carpet.baxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1093,8 +1146,10 @@ def tickformatstopdefaults(self, val): def tickmode(self): """ The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'array'] + + - One of the following enumeration values: + + ['linear', 'array'] Returns ------- @@ -1112,8 +1167,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1131,8 +1188,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1224,9 +1283,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.baxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.carpet.baxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1246,8 +1305,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'date', 'category'] Returns ------- diff --git a/plotly/graph_objects/carpet/_font.py b/plotly/graph_objects/carpet/_font.py index d67a375503..b6273033e7 100644 --- a/plotly/graph_objects/carpet/_font.py +++ b/plotly/graph_objects/carpet/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/carpet/_legendgrouptitle.py b/plotly/graph_objects/carpet/_legendgrouptitle.py index 441f7ef077..97a3d440c9 100644 --- a/plotly/graph_objects/carpet/_legendgrouptitle.py +++ b/plotly/graph_objects/carpet/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.carpet.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/carpet/_stream.py b/plotly/graph_objects/carpet/_stream.py index ae5b5ce32e..99720fa139 100644 --- a/plotly/graph_objects/carpet/_stream.py +++ b/plotly/graph_objects/carpet/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/carpet/aaxis/_tickfont.py b/plotly/graph_objects/carpet/aaxis/_tickfont.py index 156fed4c1d..d0183cdae3 100644 --- a/plotly/graph_objects/carpet/aaxis/_tickfont.py +++ b/plotly/graph_objects/carpet/aaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/carpet/aaxis/_tickformatstop.py b/plotly/graph_objects/carpet/aaxis/_tickformatstop.py index adde2ee62f..d0f42c5259 100644 --- a/plotly/graph_objects/carpet/aaxis/_tickformatstop.py +++ b/plotly/graph_objects/carpet/aaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/carpet/aaxis/_title.py b/plotly/graph_objects/carpet/aaxis/_title.py index 534ae3576b..6d9d717e6b 100644 --- a/plotly/graph_objects/carpet/aaxis/_title.py +++ b/plotly/graph_objects/carpet/aaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.aaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.carpet.aaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,7 +39,7 @@ def offset(self): The 'offset' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -57,8 +57,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/carpet/aaxis/title/_font.py b/plotly/graph_objects/carpet/aaxis/title/_font.py index 0be22d45ef..89b1579032 100644 --- a/plotly/graph_objects/carpet/aaxis/title/_font.py +++ b/plotly/graph_objects/carpet/aaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/carpet/baxis/_tickfont.py b/plotly/graph_objects/carpet/baxis/_tickfont.py index be1a5a559e..9aae460dcb 100644 --- a/plotly/graph_objects/carpet/baxis/_tickfont.py +++ b/plotly/graph_objects/carpet/baxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/carpet/baxis/_tickformatstop.py b/plotly/graph_objects/carpet/baxis/_tickformatstop.py index d43aa2d5ee..cd24181878 100644 --- a/plotly/graph_objects/carpet/baxis/_tickformatstop.py +++ b/plotly/graph_objects/carpet/baxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/carpet/baxis/_title.py b/plotly/graph_objects/carpet/baxis/_title.py index 4fdd80a5bc..2b056c9ab0 100644 --- a/plotly/graph_objects/carpet/baxis/_title.py +++ b/plotly/graph_objects/carpet/baxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.carpet.baxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.carpet.baxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,7 +39,7 @@ def offset(self): The 'offset' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -57,8 +57,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/carpet/baxis/title/_font.py b/plotly/graph_objects/carpet/baxis/title/_font.py index 7d39c5f710..59ca11a2aa 100644 --- a/plotly/graph_objects/carpet/baxis/title/_font.py +++ b/plotly/graph_objects/carpet/baxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/carpet/legendgrouptitle/_font.py b/plotly/graph_objects/carpet/legendgrouptitle/_font.py index 49eae3bd2b..71c9855eea 100644 --- a/plotly/graph_objects/carpet/legendgrouptitle/_font.py +++ b/plotly/graph_objects/carpet/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choropleth/_colorbar.py b/plotly/graph_objects/choropleth/_colorbar.py index 96511e5044..1988f5d4a2 100644 --- a/plotly/graph_objects/choropleth/_colorbar.py +++ b/plotly/graph_objects/choropleth/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.choropleth.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.choropleth.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.choropleth.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -632,9 +659,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.choropleth.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -655,8 +682,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -676,10 +705,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -702,7 +733,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -721,7 +753,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -745,8 +778,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -764,8 +799,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -785,8 +822,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -804,8 +843,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -898,7 +939,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -915,9 +957,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.choropleth.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -942,7 +984,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,8 +1005,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -982,7 +1026,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1002,8 +1047,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1028,7 +1075,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1049,8 +1096,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1068,7 +1117,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1088,8 +1138,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/choropleth/_hoverlabel.py b/plotly/graph_objects/choropleth/_hoverlabel.py index 09bcf5424c..fd1b750abe 100644 --- a/plotly/graph_objects/choropleth/_hoverlabel.py +++ b/plotly/graph_objects/choropleth/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choropleth.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/choropleth/_legendgrouptitle.py b/plotly/graph_objects/choropleth/_legendgrouptitle.py index 4a93e13e72..43a218f2ed 100644 --- a/plotly/graph_objects/choropleth/_legendgrouptitle.py +++ b/plotly/graph_objects/choropleth/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choropleth.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choropleth/_marker.py b/plotly/graph_objects/choropleth/_marker.py index 67ca1a1cf9..0b550f96b4 100644 --- a/plotly/graph_objects/choropleth/_marker.py +++ b/plotly/graph_objects/choropleth/_marker.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.choropleth.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -35,8 +35,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/choropleth/_selected.py b/plotly/graph_objects/choropleth/_selected.py index 577980dadf..4c8e817270 100644 --- a/plotly/graph_objects/choropleth/_selected.py +++ b/plotly/graph_objects/choropleth/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choropleth.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/choropleth/_stream.py b/plotly/graph_objects/choropleth/_stream.py index f6a3669860..e5d3229c4e 100644 --- a/plotly/graph_objects/choropleth/_stream.py +++ b/plotly/graph_objects/choropleth/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/choropleth/_unselected.py b/plotly/graph_objects/choropleth/_unselected.py index 099443cc73..0bad3f228b 100644 --- a/plotly/graph_objects/choropleth/_unselected.py +++ b/plotly/graph_objects/choropleth/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choropleth.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/choropleth/colorbar/_tickfont.py b/plotly/graph_objects/choropleth/colorbar/_tickfont.py index 039c66b8b9..346e3294d2 100644 --- a/plotly/graph_objects/choropleth/colorbar/_tickfont.py +++ b/plotly/graph_objects/choropleth/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choropleth/colorbar/_tickformatstop.py b/plotly/graph_objects/choropleth/colorbar/_tickformatstop.py index aab079f688..f96ae9904e 100644 --- a/plotly/graph_objects/choropleth/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/choropleth/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choropleth/colorbar/_title.py b/plotly/graph_objects/choropleth/colorbar/_title.py index 9bd179c34b..7e9f70a490 100644 --- a/plotly/graph_objects/choropleth/colorbar/_title.py +++ b/plotly/graph_objects/choropleth/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choropleth.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choropleth.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choropleth/colorbar/title/_font.py b/plotly/graph_objects/choropleth/colorbar/title/_font.py index 4c8a22a9a5..e4b0985b09 100644 --- a/plotly/graph_objects/choropleth/colorbar/title/_font.py +++ b/plotly/graph_objects/choropleth/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choropleth/hoverlabel/_font.py b/plotly/graph_objects/choropleth/hoverlabel/_font.py index 0bc77937e0..8fe08e53ab 100644 --- a/plotly/graph_objects/choropleth/hoverlabel/_font.py +++ b/plotly/graph_objects/choropleth/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/choropleth/legendgrouptitle/_font.py b/plotly/graph_objects/choropleth/legendgrouptitle/_font.py index 12e09e40b1..68f5c96b57 100644 --- a/plotly/graph_objects/choropleth/legendgrouptitle/_font.py +++ b/plotly/graph_objects/choropleth/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choropleth/marker/_line.py b/plotly/graph_objects/choropleth/marker/_line.py index cb874d16eb..a5dfacbd4f 100644 --- a/plotly/graph_objects/choropleth/marker/_line.py +++ b/plotly/graph_objects/choropleth/marker/_line.py @@ -19,12 +19,13 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -60,8 +61,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/choropleth/selected/_marker.py b/plotly/graph_objects/choropleth/selected/_marker.py index abc136f206..5197cebde1 100644 --- a/plotly/graph_objects/choropleth/selected/_marker.py +++ b/plotly/graph_objects/choropleth/selected/_marker.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/choropleth/unselected/_marker.py b/plotly/graph_objects/choropleth/unselected/_marker.py index 8fdd72a36d..1927eec28f 100644 --- a/plotly/graph_objects/choropleth/unselected/_marker.py +++ b/plotly/graph_objects/choropleth/unselected/_marker.py @@ -17,7 +17,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/choroplethmap/_colorbar.py b/plotly/graph_objects/choroplethmap/_colorbar.py index f7ccee0ad2..d105bf4126 100644 --- a/plotly/graph_objects/choroplethmap/_colorbar.py +++ b/plotly/graph_objects/choroplethmap/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.choroplethmap.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.choroplethmap.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/choroplethmap/_hoverlabel.py b/plotly/graph_objects/choroplethmap/_hoverlabel.py index bea147289d..d8f8c8b872 100644 --- a/plotly/graph_objects/choroplethmap/_hoverlabel.py +++ b/plotly/graph_objects/choroplethmap/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/choroplethmap/_legendgrouptitle.py b/plotly/graph_objects/choroplethmap/_legendgrouptitle.py index 50cb181da0..82defea4d6 100644 --- a/plotly/graph_objects/choroplethmap/_legendgrouptitle.py +++ b/plotly/graph_objects/choroplethmap/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choroplethmap/_marker.py b/plotly/graph_objects/choroplethmap/_marker.py index e73d01b0b0..0f4f0b6fb5 100644 --- a/plotly/graph_objects/choroplethmap/_marker.py +++ b/plotly/graph_objects/choroplethmap/_marker.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -35,8 +35,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/choroplethmap/_selected.py b/plotly/graph_objects/choroplethmap/_selected.py index 97f23ae5b6..a72fd81d19 100644 --- a/plotly/graph_objects/choroplethmap/_selected.py +++ b/plotly/graph_objects/choroplethmap/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/choroplethmap/_stream.py b/plotly/graph_objects/choroplethmap/_stream.py index 6bd4273349..6f3829b118 100644 --- a/plotly/graph_objects/choroplethmap/_stream.py +++ b/plotly/graph_objects/choroplethmap/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/choroplethmap/_unselected.py b/plotly/graph_objects/choroplethmap/_unselected.py index c9e58bc607..56a0f3d2a6 100644 --- a/plotly/graph_objects/choroplethmap/_unselected.py +++ b/plotly/graph_objects/choroplethmap/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/choroplethmap/colorbar/_tickfont.py b/plotly/graph_objects/choroplethmap/colorbar/_tickfont.py index 3619cd6f56..c0580c9ac3 100644 --- a/plotly/graph_objects/choroplethmap/colorbar/_tickfont.py +++ b/plotly/graph_objects/choroplethmap/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choroplethmap/colorbar/_tickformatstop.py b/plotly/graph_objects/choroplethmap/colorbar/_tickformatstop.py index 8c6fbde793..36988c51ec 100644 --- a/plotly/graph_objects/choroplethmap/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/choroplethmap/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choroplethmap/colorbar/_title.py b/plotly/graph_objects/choroplethmap/colorbar/_title.py index e91b2a5638..93fb7fc716 100644 --- a/plotly/graph_objects/choroplethmap/colorbar/_title.py +++ b/plotly/graph_objects/choroplethmap/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choroplethmap.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choroplethmap/colorbar/title/_font.py b/plotly/graph_objects/choroplethmap/colorbar/title/_font.py index 8bfc13c4da..e5574fb778 100644 --- a/plotly/graph_objects/choroplethmap/colorbar/title/_font.py +++ b/plotly/graph_objects/choroplethmap/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choroplethmap/hoverlabel/_font.py b/plotly/graph_objects/choroplethmap/hoverlabel/_font.py index 852abfdae6..000e95ea4c 100644 --- a/plotly/graph_objects/choroplethmap/hoverlabel/_font.py +++ b/plotly/graph_objects/choroplethmap/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/choroplethmap/legendgrouptitle/_font.py b/plotly/graph_objects/choroplethmap/legendgrouptitle/_font.py index 47a8a01b48..3592b5a28c 100644 --- a/plotly/graph_objects/choroplethmap/legendgrouptitle/_font.py +++ b/plotly/graph_objects/choroplethmap/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choroplethmap/marker/_line.py b/plotly/graph_objects/choroplethmap/marker/_line.py index 7cf279dfed..00bcccdd2b 100644 --- a/plotly/graph_objects/choroplethmap/marker/_line.py +++ b/plotly/graph_objects/choroplethmap/marker/_line.py @@ -19,12 +19,13 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -60,8 +61,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/choroplethmap/selected/_marker.py b/plotly/graph_objects/choroplethmap/selected/_marker.py index 03e8bb9b9b..1a139451d8 100644 --- a/plotly/graph_objects/choroplethmap/selected/_marker.py +++ b/plotly/graph_objects/choroplethmap/selected/_marker.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/choroplethmap/unselected/_marker.py b/plotly/graph_objects/choroplethmap/unselected/_marker.py index ad80d3b880..fe5cfd3677 100644 --- a/plotly/graph_objects/choroplethmap/unselected/_marker.py +++ b/plotly/graph_objects/choroplethmap/unselected/_marker.py @@ -17,7 +17,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/_colorbar.py b/plotly/graph_objects/choroplethmapbox/_colorbar.py index 9a56179df6..8a87b1e98c 100644 --- a/plotly/graph_objects/choroplethmapbox/_colorbar.py +++ b/plotly/graph_objects/choroplethmapbox/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.choroplethmapbox.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.choroplethmapbox.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/_hoverlabel.py b/plotly/graph_objects/choroplethmapbox/_hoverlabel.py index bf80839c4e..2e6d69fafd 100644 --- a/plotly/graph_objects/choroplethmapbox/_hoverlabel.py +++ b/plotly/graph_objects/choroplethmapbox/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/choroplethmapbox/_legendgrouptitle.py b/plotly/graph_objects/choroplethmapbox/_legendgrouptitle.py index 1cbe62455e..533d9ffc28 100644 --- a/plotly/graph_objects/choroplethmapbox/_legendgrouptitle.py +++ b/plotly/graph_objects/choroplethmapbox/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/_marker.py b/plotly/graph_objects/choroplethmapbox/_marker.py index cff9ced343..dea404c361 100644 --- a/plotly/graph_objects/choroplethmapbox/_marker.py +++ b/plotly/graph_objects/choroplethmapbox/_marker.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -35,8 +35,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/_selected.py b/plotly/graph_objects/choroplethmapbox/_selected.py index 3ff84e8ada..6572795b77 100644 --- a/plotly/graph_objects/choroplethmapbox/_selected.py +++ b/plotly/graph_objects/choroplethmapbox/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/_stream.py b/plotly/graph_objects/choroplethmapbox/_stream.py index 7e8f355703..bd3e37cff3 100644 --- a/plotly/graph_objects/choroplethmapbox/_stream.py +++ b/plotly/graph_objects/choroplethmapbox/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/_unselected.py b/plotly/graph_objects/choroplethmapbox/_unselected.py index 38add76be3..b8cd750a12 100644 --- a/plotly/graph_objects/choroplethmapbox/_unselected.py +++ b/plotly/graph_objects/choroplethmapbox/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/colorbar/_tickfont.py b/plotly/graph_objects/choroplethmapbox/colorbar/_tickfont.py index d302023663..dba28a330d 100644 --- a/plotly/graph_objects/choroplethmapbox/colorbar/_tickfont.py +++ b/plotly/graph_objects/choroplethmapbox/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choroplethmapbox/colorbar/_tickformatstop.py b/plotly/graph_objects/choroplethmapbox/colorbar/_tickformatstop.py index 4367f1d3e8..5935ed37fc 100644 --- a/plotly/graph_objects/choroplethmapbox/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/choroplethmapbox/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/colorbar/_title.py b/plotly/graph_objects/choroplethmapbox/colorbar/_title.py index f9e0b23a62..276c21d4db 100644 --- a/plotly/graph_objects/choroplethmapbox/colorbar/_title.py +++ b/plotly/graph_objects/choroplethmapbox/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.choroplethmapbox.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/colorbar/title/_font.py b/plotly/graph_objects/choroplethmapbox/colorbar/title/_font.py index d5ea2c01a1..96d8dfbe1f 100644 --- a/plotly/graph_objects/choroplethmapbox/colorbar/title/_font.py +++ b/plotly/graph_objects/choroplethmapbox/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choroplethmapbox/hoverlabel/_font.py b/plotly/graph_objects/choroplethmapbox/hoverlabel/_font.py index 4295ab76a1..2827c78e60 100644 --- a/plotly/graph_objects/choroplethmapbox/hoverlabel/_font.py +++ b/plotly/graph_objects/choroplethmapbox/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/choroplethmapbox/legendgrouptitle/_font.py b/plotly/graph_objects/choroplethmapbox/legendgrouptitle/_font.py index 4dec64fb79..c0f718c219 100644 --- a/plotly/graph_objects/choroplethmapbox/legendgrouptitle/_font.py +++ b/plotly/graph_objects/choroplethmapbox/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/choroplethmapbox/marker/_line.py b/plotly/graph_objects/choroplethmapbox/marker/_line.py index 941029ef5a..b107d2a73e 100644 --- a/plotly/graph_objects/choroplethmapbox/marker/_line.py +++ b/plotly/graph_objects/choroplethmapbox/marker/_line.py @@ -19,12 +19,13 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -60,8 +61,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/selected/_marker.py b/plotly/graph_objects/choroplethmapbox/selected/_marker.py index 53590ff1f6..61d0457d95 100644 --- a/plotly/graph_objects/choroplethmapbox/selected/_marker.py +++ b/plotly/graph_objects/choroplethmapbox/selected/_marker.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/choroplethmapbox/unselected/_marker.py b/plotly/graph_objects/choroplethmapbox/unselected/_marker.py index 2bb0c402c5..ad5a4436e6 100644 --- a/plotly/graph_objects/choroplethmapbox/unselected/_marker.py +++ b/plotly/graph_objects/choroplethmapbox/unselected/_marker.py @@ -17,7 +17,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/cone/_colorbar.py b/plotly/graph_objects/cone/_colorbar.py index 2e7d4a986c..28868ca8e8 100644 --- a/plotly/graph_objects/cone/_colorbar.py +++ b/plotly/graph_objects/cone/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.cone.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.cone.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.cone.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.cone.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.cone.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/cone/_hoverlabel.py b/plotly/graph_objects/cone/_hoverlabel.py index 1e6c079f0e..951d34c74b 100644 --- a/plotly/graph_objects/cone/_hoverlabel.py +++ b/plotly/graph_objects/cone/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.cone.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/cone/_legendgrouptitle.py b/plotly/graph_objects/cone/_legendgrouptitle.py index a162805ae1..f84ae00164 100644 --- a/plotly/graph_objects/cone/_legendgrouptitle.py +++ b/plotly/graph_objects/cone/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.cone.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/cone/_lighting.py b/plotly/graph_objects/cone/_lighting.py index 3292df234d..33ed706c06 100644 --- a/plotly/graph_objects/cone/_lighting.py +++ b/plotly/graph_objects/cone/_lighting.py @@ -25,7 +25,8 @@ def ambient(self): out the image. The 'ambient' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -44,7 +45,8 @@ def diffuse(self): range of angles. The 'diffuse' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -63,7 +65,8 @@ def facenormalsepsilon(self): from degenerate geometry. The 'facenormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -83,7 +86,8 @@ def fresnel(self): 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] + + - An int or float in the interval [0, 5] Returns ------- @@ -102,7 +106,8 @@ def roughness(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -121,7 +126,8 @@ def specular(self): single direction, causing shine. The 'specular' property is a number and may be specified as: - - An int or float in the interval [0, 2] + + - An int or float in the interval [0, 2] Returns ------- @@ -140,7 +146,8 @@ def vertexnormalsepsilon(self): arising from degenerate geometry. The 'vertexnormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/cone/_lightposition.py b/plotly/graph_objects/cone/_lightposition.py index 84468912ad..48677f4001 100644 --- a/plotly/graph_objects/cone/_lightposition.py +++ b/plotly/graph_objects/cone/_lightposition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -34,7 +35,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -52,7 +54,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- diff --git a/plotly/graph_objects/cone/_stream.py b/plotly/graph_objects/cone/_stream.py index 5e438b1222..9f27c06d6f 100644 --- a/plotly/graph_objects/cone/_stream.py +++ b/plotly/graph_objects/cone/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/cone/colorbar/_tickfont.py b/plotly/graph_objects/cone/colorbar/_tickfont.py index e1f3047752..f1271f525f 100644 --- a/plotly/graph_objects/cone/colorbar/_tickfont.py +++ b/plotly/graph_objects/cone/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/cone/colorbar/_tickformatstop.py b/plotly/graph_objects/cone/colorbar/_tickformatstop.py index e360b8506f..8de5b18256 100644 --- a/plotly/graph_objects/cone/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/cone/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/cone/colorbar/_title.py b/plotly/graph_objects/cone/colorbar/_title.py index 14cf34ae98..2ac0f59d9f 100644 --- a/plotly/graph_objects/cone/colorbar/_title.py +++ b/plotly/graph_objects/cone/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.cone.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.cone.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/cone/colorbar/title/_font.py b/plotly/graph_objects/cone/colorbar/title/_font.py index c966f8c32e..aa5dcf7aa4 100644 --- a/plotly/graph_objects/cone/colorbar/title/_font.py +++ b/plotly/graph_objects/cone/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/cone/hoverlabel/_font.py b/plotly/graph_objects/cone/hoverlabel/_font.py index 20df1b8ab5..5f3f097c0a 100644 --- a/plotly/graph_objects/cone/hoverlabel/_font.py +++ b/plotly/graph_objects/cone/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/cone/legendgrouptitle/_font.py b/plotly/graph_objects/cone/legendgrouptitle/_font.py index d32dcfd644..c9cf90e401 100644 --- a/plotly/graph_objects/cone/legendgrouptitle/_font.py +++ b/plotly/graph_objects/cone/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contour/_colorbar.py b/plotly/graph_objects/contour/_colorbar.py index e21636f320..31d6e3ce7d 100644 --- a/plotly/graph_objects/contour/_colorbar.py +++ b/plotly/graph_objects/contour/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.contour.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.contour.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.contour.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.contour.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.contour.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/contour/_contours.py b/plotly/graph_objects/contour/_contours.py index 1e21654f7f..35104f4100 100644 --- a/plotly/graph_objects/contour/_contours.py +++ b/plotly/graph_objects/contour/_contours.py @@ -32,8 +32,10 @@ def coloring(self): 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'] + + - One of the following enumeration values: + + ['fill', 'heatmap', 'lines', 'none'] Returns ------- @@ -53,7 +55,7 @@ def end(self): The 'end' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -74,9 +76,9 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.contours.Labelfont` - - A dict of string/value properties that will be passed - to the Labelfont constructor + + - An instance of :class:`plotly.graph_objects.contour.contours.Labelfont` + - A dict of string/value properties that will be passed to the Labelfont constructor Returns ------- @@ -97,8 +99,10 @@ def labelformat(self): https://github.com/d3/d3-format/tree/v1.4.5#d3-format. The 'labelformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -123,9 +127,11 @@ def operation(self): transforms. The 'operation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')['] + + - One of the following enumeration values: + + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] Returns ------- @@ -181,7 +187,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -201,7 +208,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,8 +229,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['levels', 'constraint'] Returns ------- diff --git a/plotly/graph_objects/contour/_hoverlabel.py b/plotly/graph_objects/contour/_hoverlabel.py index c82d18febd..2a1f940bb8 100644 --- a/plotly/graph_objects/contour/_hoverlabel.py +++ b/plotly/graph_objects/contour/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.contour.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/contour/_legendgrouptitle.py b/plotly/graph_objects/contour/_legendgrouptitle.py index c245a09274..28ab64aa96 100644 --- a/plotly/graph_objects/contour/_legendgrouptitle.py +++ b/plotly/graph_objects/contour/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.contour.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/contour/_line.py b/plotly/graph_objects/contour/_line.py index f153f0d077..a29648e1bd 100644 --- a/plotly/graph_objects/contour/_line.py +++ b/plotly/graph_objects/contour/_line.py @@ -17,11 +17,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,10 +43,14 @@ def dash(self): "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.) + + - 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 ------- @@ -64,7 +69,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -84,7 +90,8 @@ def width(self): is "constraint". The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/contour/_stream.py b/plotly/graph_objects/contour/_stream.py index 106f43e2f8..6821505a62 100644 --- a/plotly/graph_objects/contour/_stream.py +++ b/plotly/graph_objects/contour/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/contour/_textfont.py b/plotly/graph_objects/contour/_textfont.py index 96f056fe23..4a1f69de2e 100644 --- a/plotly/graph_objects/contour/_textfont.py +++ b/plotly/graph_objects/contour/_textfont.py @@ -24,11 +24,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contour/colorbar/_tickfont.py b/plotly/graph_objects/contour/colorbar/_tickfont.py index b7793f5aa7..64bda54237 100644 --- a/plotly/graph_objects/contour/colorbar/_tickfont.py +++ b/plotly/graph_objects/contour/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contour/colorbar/_tickformatstop.py b/plotly/graph_objects/contour/colorbar/_tickformatstop.py index 5f3bd89a1f..f393e1d8a1 100644 --- a/plotly/graph_objects/contour/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/contour/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/contour/colorbar/_title.py b/plotly/graph_objects/contour/colorbar/_title.py index d3808bedaf..f76aef50f4 100644 --- a/plotly/graph_objects/contour/colorbar/_title.py +++ b/plotly/graph_objects/contour/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.contour.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.contour.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/contour/colorbar/title/_font.py b/plotly/graph_objects/contour/colorbar/title/_font.py index db981d4477..b04d56afc9 100644 --- a/plotly/graph_objects/contour/colorbar/title/_font.py +++ b/plotly/graph_objects/contour/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contour/contours/_labelfont.py b/plotly/graph_objects/contour/contours/_labelfont.py index 18f50636cb..a731f3794c 100644 --- a/plotly/graph_objects/contour/contours/_labelfont.py +++ b/plotly/graph_objects/contour/contours/_labelfont.py @@ -24,11 +24,12 @@ class Labelfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contour/hoverlabel/_font.py b/plotly/graph_objects/contour/hoverlabel/_font.py index 5dbbaf010f..bf67dcc29f 100644 --- a/plotly/graph_objects/contour/hoverlabel/_font.py +++ b/plotly/graph_objects/contour/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/contour/legendgrouptitle/_font.py b/plotly/graph_objects/contour/legendgrouptitle/_font.py index 0c045d40bc..bd61114f94 100644 --- a/plotly/graph_objects/contour/legendgrouptitle/_font.py +++ b/plotly/graph_objects/contour/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contourcarpet/_colorbar.py b/plotly/graph_objects/contourcarpet/_colorbar.py index f958dc7ab0..7b439085e9 100644 --- a/plotly/graph_objects/contourcarpet/_colorbar.py +++ b/plotly/graph_objects/contourcarpet/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.contourcarpet.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.contourcarpet.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/contourcarpet/_contours.py b/plotly/graph_objects/contourcarpet/_contours.py index 65abd1c416..4481902901 100644 --- a/plotly/graph_objects/contourcarpet/_contours.py +++ b/plotly/graph_objects/contourcarpet/_contours.py @@ -31,8 +31,10 @@ def coloring(self): 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'] + + - One of the following enumeration values: + + ['fill', 'lines', 'none'] Returns ------- @@ -52,7 +54,7 @@ def end(self): The 'end' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -73,9 +75,9 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.contours.Labelfont` - - A dict of string/value properties that will be passed - to the Labelfont constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.contours.Labelfont` + - A dict of string/value properties that will be passed to the Labelfont constructor Returns ------- @@ -96,8 +98,10 @@ def labelformat(self): https://github.com/d3/d3-format/tree/v1.4.5#d3-format. The 'labelformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -122,9 +126,11 @@ def operation(self): transforms. The 'operation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')['] + + - One of the following enumeration values: + + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] Returns ------- @@ -180,7 +186,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -200,7 +207,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -221,8 +228,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['levels', 'constraint'] Returns ------- diff --git a/plotly/graph_objects/contourcarpet/_legendgrouptitle.py b/plotly/graph_objects/contourcarpet/_legendgrouptitle.py index 2756557439..a1221e2a85 100644 --- a/plotly/graph_objects/contourcarpet/_legendgrouptitle.py +++ b/plotly/graph_objects/contourcarpet/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/contourcarpet/_line.py b/plotly/graph_objects/contourcarpet/_line.py index a2b76baef1..fe855ba4a2 100644 --- a/plotly/graph_objects/contourcarpet/_line.py +++ b/plotly/graph_objects/contourcarpet/_line.py @@ -17,11 +17,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,10 +43,14 @@ def dash(self): "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.) + + - 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 ------- @@ -64,7 +69,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -84,7 +90,8 @@ def width(self): is "constraint". The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/contourcarpet/_stream.py b/plotly/graph_objects/contourcarpet/_stream.py index 9ee95acb5f..a86e9d06c5 100644 --- a/plotly/graph_objects/contourcarpet/_stream.py +++ b/plotly/graph_objects/contourcarpet/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/contourcarpet/colorbar/_tickfont.py b/plotly/graph_objects/contourcarpet/colorbar/_tickfont.py index e449943f78..3f5bf0920c 100644 --- a/plotly/graph_objects/contourcarpet/colorbar/_tickfont.py +++ b/plotly/graph_objects/contourcarpet/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contourcarpet/colorbar/_tickformatstop.py b/plotly/graph_objects/contourcarpet/colorbar/_tickformatstop.py index cb4579b844..58de731205 100644 --- a/plotly/graph_objects/contourcarpet/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/contourcarpet/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/contourcarpet/colorbar/_title.py b/plotly/graph_objects/contourcarpet/colorbar/_title.py index 57a53740ef..b1f9dfab43 100644 --- a/plotly/graph_objects/contourcarpet/colorbar/_title.py +++ b/plotly/graph_objects/contourcarpet/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.contourcarpet.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/contourcarpet/colorbar/title/_font.py b/plotly/graph_objects/contourcarpet/colorbar/title/_font.py index d32d51aaed..bd2003a038 100644 --- a/plotly/graph_objects/contourcarpet/colorbar/title/_font.py +++ b/plotly/graph_objects/contourcarpet/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contourcarpet/contours/_labelfont.py b/plotly/graph_objects/contourcarpet/contours/_labelfont.py index 6123417d38..f0a7eabcc5 100644 --- a/plotly/graph_objects/contourcarpet/contours/_labelfont.py +++ b/plotly/graph_objects/contourcarpet/contours/_labelfont.py @@ -24,11 +24,12 @@ class Labelfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/contourcarpet/legendgrouptitle/_font.py b/plotly/graph_objects/contourcarpet/legendgrouptitle/_font.py index 1d0147a974..a04c3361d3 100644 --- a/plotly/graph_objects/contourcarpet/legendgrouptitle/_font.py +++ b/plotly/graph_objects/contourcarpet/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/densitymap/_colorbar.py b/plotly/graph_objects/densitymap/_colorbar.py index 2b7211fc4f..8ede462dca 100644 --- a/plotly/graph_objects/densitymap/_colorbar.py +++ b/plotly/graph_objects/densitymap/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.densitymap.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.densitymap.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.densitymap.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -632,9 +659,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.densitymap.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -655,8 +682,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -676,10 +705,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -702,7 +733,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -721,7 +753,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -745,8 +778,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -764,8 +799,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -785,8 +822,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -804,8 +843,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -898,7 +939,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -915,9 +957,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.densitymap.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -942,7 +984,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,8 +1005,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -982,7 +1026,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1002,8 +1047,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1028,7 +1075,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1049,8 +1096,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1068,7 +1117,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1088,8 +1138,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/densitymap/_hoverlabel.py b/plotly/graph_objects/densitymap/_hoverlabel.py index f9a0775d72..5a1b0604f8 100644 --- a/plotly/graph_objects/densitymap/_hoverlabel.py +++ b/plotly/graph_objects/densitymap/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.densitymap.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/densitymap/_legendgrouptitle.py b/plotly/graph_objects/densitymap/_legendgrouptitle.py index 7a90ce76b9..6979c9566f 100644 --- a/plotly/graph_objects/densitymap/_legendgrouptitle.py +++ b/plotly/graph_objects/densitymap/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.densitymap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/densitymap/_stream.py b/plotly/graph_objects/densitymap/_stream.py index 7ef7fb642c..88a7806a3d 100644 --- a/plotly/graph_objects/densitymap/_stream.py +++ b/plotly/graph_objects/densitymap/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/densitymap/colorbar/_tickfont.py b/plotly/graph_objects/densitymap/colorbar/_tickfont.py index 4a3a5c8987..6b583687bf 100644 --- a/plotly/graph_objects/densitymap/colorbar/_tickfont.py +++ b/plotly/graph_objects/densitymap/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/densitymap/colorbar/_tickformatstop.py b/plotly/graph_objects/densitymap/colorbar/_tickformatstop.py index 4ab9da54b3..3316fe39f4 100644 --- a/plotly/graph_objects/densitymap/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/densitymap/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/densitymap/colorbar/_title.py b/plotly/graph_objects/densitymap/colorbar/_title.py index 64634af3cc..6a54dc130f 100644 --- a/plotly/graph_objects/densitymap/colorbar/_title.py +++ b/plotly/graph_objects/densitymap/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymap.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.densitymap.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/densitymap/colorbar/title/_font.py b/plotly/graph_objects/densitymap/colorbar/title/_font.py index 2cf038ede6..9420ff4056 100644 --- a/plotly/graph_objects/densitymap/colorbar/title/_font.py +++ b/plotly/graph_objects/densitymap/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/densitymap/hoverlabel/_font.py b/plotly/graph_objects/densitymap/hoverlabel/_font.py index 6ac4d97c17..7b16978965 100644 --- a/plotly/graph_objects/densitymap/hoverlabel/_font.py +++ b/plotly/graph_objects/densitymap/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/densitymap/legendgrouptitle/_font.py b/plotly/graph_objects/densitymap/legendgrouptitle/_font.py index d1cee28ca0..ad04607f7c 100644 --- a/plotly/graph_objects/densitymap/legendgrouptitle/_font.py +++ b/plotly/graph_objects/densitymap/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/densitymapbox/_colorbar.py b/plotly/graph_objects/densitymapbox/_colorbar.py index 9e1011a40f..d839dd598b 100644 --- a/plotly/graph_objects/densitymapbox/_colorbar.py +++ b/plotly/graph_objects/densitymapbox/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.densitymapbox.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.densitymapbox.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/densitymapbox/_hoverlabel.py b/plotly/graph_objects/densitymapbox/_hoverlabel.py index 75ecf5f1ce..8a0b9c17db 100644 --- a/plotly/graph_objects/densitymapbox/_hoverlabel.py +++ b/plotly/graph_objects/densitymapbox/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/densitymapbox/_legendgrouptitle.py b/plotly/graph_objects/densitymapbox/_legendgrouptitle.py index 15debde7fd..2299e03813 100644 --- a/plotly/graph_objects/densitymapbox/_legendgrouptitle.py +++ b/plotly/graph_objects/densitymapbox/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/densitymapbox/_stream.py b/plotly/graph_objects/densitymapbox/_stream.py index 493fea6c8f..3d83a967f3 100644 --- a/plotly/graph_objects/densitymapbox/_stream.py +++ b/plotly/graph_objects/densitymapbox/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/densitymapbox/colorbar/_tickfont.py b/plotly/graph_objects/densitymapbox/colorbar/_tickfont.py index 6a3fb922b4..d6f38aa1fd 100644 --- a/plotly/graph_objects/densitymapbox/colorbar/_tickfont.py +++ b/plotly/graph_objects/densitymapbox/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/densitymapbox/colorbar/_tickformatstop.py b/plotly/graph_objects/densitymapbox/colorbar/_tickformatstop.py index c4c1c212b4..50b9e9e250 100644 --- a/plotly/graph_objects/densitymapbox/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/densitymapbox/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/densitymapbox/colorbar/_title.py b/plotly/graph_objects/densitymapbox/colorbar/_title.py index 1b4d804747..c34fe05637 100644 --- a/plotly/graph_objects/densitymapbox/colorbar/_title.py +++ b/plotly/graph_objects/densitymapbox/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.densitymapbox.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/densitymapbox/colorbar/title/_font.py b/plotly/graph_objects/densitymapbox/colorbar/title/_font.py index 8a93dd999d..76600b839e 100644 --- a/plotly/graph_objects/densitymapbox/colorbar/title/_font.py +++ b/plotly/graph_objects/densitymapbox/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/densitymapbox/hoverlabel/_font.py b/plotly/graph_objects/densitymapbox/hoverlabel/_font.py index 25e12dd0ad..6dc3fb7500 100644 --- a/plotly/graph_objects/densitymapbox/hoverlabel/_font.py +++ b/plotly/graph_objects/densitymapbox/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/densitymapbox/legendgrouptitle/_font.py b/plotly/graph_objects/densitymapbox/legendgrouptitle/_font.py index ea16e04734..6dab90cf54 100644 --- a/plotly/graph_objects/densitymapbox/legendgrouptitle/_font.py +++ b/plotly/graph_objects/densitymapbox/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/funnel/_connector.py b/plotly/graph_objects/funnel/_connector.py index 9fc520a608..41c1a0ffa5 100644 --- a/plotly/graph_objects/funnel/_connector.py +++ b/plotly/graph_objects/funnel/_connector.py @@ -16,11 +16,12 @@ def fillcolor(self): Sets the fill color. The 'fillcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.connector.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.funnel.connector.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/funnel/_hoverlabel.py b/plotly/graph_objects/funnel/_hoverlabel.py index 6736fee980..9c37f14c61 100644 --- a/plotly/graph_objects/funnel/_hoverlabel.py +++ b/plotly/graph_objects/funnel/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.funnel.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/funnel/_insidetextfont.py b/plotly/graph_objects/funnel/_insidetextfont.py index 0719936a77..676f21c80f 100644 --- a/plotly/graph_objects/funnel/_insidetextfont.py +++ b/plotly/graph_objects/funnel/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnel/_legendgrouptitle.py b/plotly/graph_objects/funnel/_legendgrouptitle.py index a8aad83d4c..bb5b931bed 100644 --- a/plotly/graph_objects/funnel/_legendgrouptitle.py +++ b/plotly/graph_objects/funnel/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.funnel.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/funnel/_marker.py b/plotly/graph_objects/funnel/_marker.py index 9a3ea917bc..d2183ef873 100644 --- a/plotly/graph_objects/funnel/_marker.py +++ b/plotly/graph_objects/funnel/_marker.py @@ -83,7 +83,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -106,7 +106,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -128,7 +128,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -149,14 +149,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to funnel.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to funnel.marker.colorscale + - A list or array of any of the above Returns ------- @@ -198,9 +198,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.funnel.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -229,30 +229,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -287,9 +288,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.funnel.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -307,8 +308,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/funnel/_outsidetextfont.py b/plotly/graph_objects/funnel/_outsidetextfont.py index f87224b09b..b7a4259616 100644 --- a/plotly/graph_objects/funnel/_outsidetextfont.py +++ b/plotly/graph_objects/funnel/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnel/_stream.py b/plotly/graph_objects/funnel/_stream.py index 829cc3e303..8129070c03 100644 --- a/plotly/graph_objects/funnel/_stream.py +++ b/plotly/graph_objects/funnel/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/funnel/_textfont.py b/plotly/graph_objects/funnel/_textfont.py index c27949fcfd..329557e09f 100644 --- a/plotly/graph_objects/funnel/_textfont.py +++ b/plotly/graph_objects/funnel/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnel/connector/_line.py b/plotly/graph_objects/funnel/connector/_line.py index 77017ee4c2..86c87a9f5a 100644 --- a/plotly/graph_objects/funnel/connector/_line.py +++ b/plotly/graph_objects/funnel/connector/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/funnel/hoverlabel/_font.py b/plotly/graph_objects/funnel/hoverlabel/_font.py index 9984ee8694..85964f783a 100644 --- a/plotly/graph_objects/funnel/hoverlabel/_font.py +++ b/plotly/graph_objects/funnel/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnel/legendgrouptitle/_font.py b/plotly/graph_objects/funnel/legendgrouptitle/_font.py index 7753733137..2c3307356e 100644 --- a/plotly/graph_objects/funnel/legendgrouptitle/_font.py +++ b/plotly/graph_objects/funnel/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/funnel/marker/_colorbar.py b/plotly/graph_objects/funnel/marker/_colorbar.py index e5e7f65f50..f479e5ab34 100644 --- a/plotly/graph_objects/funnel/marker/_colorbar.py +++ b/plotly/graph_objects/funnel/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.funnel.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.funnel.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/funnel/marker/_line.py b/plotly/graph_objects/funnel/marker/_line.py index a015be96a2..f2114b30d1 100644 --- a/plotly/graph_objects/funnel/marker/_line.py +++ b/plotly/graph_objects/funnel/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to funnel.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to funnel.marker.line.colorscale + - A list or array of any of the above Returns ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/funnel/marker/colorbar/_tickfont.py b/plotly/graph_objects/funnel/marker/colorbar/_tickfont.py index 6a50ba85c0..21f117f050 100644 --- a/plotly/graph_objects/funnel/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/funnel/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/funnel/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/funnel/marker/colorbar/_tickformatstop.py index 58f497e008..7d243b0258 100644 --- a/plotly/graph_objects/funnel/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/funnel/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/funnel/marker/colorbar/_title.py b/plotly/graph_objects/funnel/marker/colorbar/_title.py index 509841a159..5743678a7c 100644 --- a/plotly/graph_objects/funnel/marker/colorbar/_title.py +++ b/plotly/graph_objects/funnel/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.funnel.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/funnel/marker/colorbar/title/_font.py b/plotly/graph_objects/funnel/marker/colorbar/title/_font.py index 1cc6879702..38f6381924 100644 --- a/plotly/graph_objects/funnel/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/funnel/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/funnelarea/_domain.py b/plotly/graph_objects/funnelarea/_domain.py index e05d580fdc..6d9c0d8673 100644 --- a/plotly/graph_objects/funnelarea/_domain.py +++ b/plotly/graph_objects/funnelarea/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this funnelarea trace . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this funnelarea trace . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/funnelarea/_hoverlabel.py b/plotly/graph_objects/funnelarea/_hoverlabel.py index b0886e4781..a40e5a0e86 100644 --- a/plotly/graph_objects/funnelarea/_hoverlabel.py +++ b/plotly/graph_objects/funnelarea/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/funnelarea/_insidetextfont.py b/plotly/graph_objects/funnelarea/_insidetextfont.py index cd37d59c49..ffcf45daa1 100644 --- a/plotly/graph_objects/funnelarea/_insidetextfont.py +++ b/plotly/graph_objects/funnelarea/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnelarea/_legendgrouptitle.py b/plotly/graph_objects/funnelarea/_legendgrouptitle.py index 389f088cc8..9b4f88dcc6 100644 --- a/plotly/graph_objects/funnelarea/_legendgrouptitle.py +++ b/plotly/graph_objects/funnelarea/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/funnelarea/_marker.py b/plotly/graph_objects/funnelarea/_marker.py index 4c1f03d868..d5b5b36f52 100644 --- a/plotly/graph_objects/funnelarea/_marker.py +++ b/plotly/graph_objects/funnelarea/_marker.py @@ -52,9 +52,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -73,9 +73,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/funnelarea/_stream.py b/plotly/graph_objects/funnelarea/_stream.py index 53eb5c2fe1..0253d6abc4 100644 --- a/plotly/graph_objects/funnelarea/_stream.py +++ b/plotly/graph_objects/funnelarea/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/funnelarea/_textfont.py b/plotly/graph_objects/funnelarea/_textfont.py index be318e48e7..ba83d5a6e3 100644 --- a/plotly/graph_objects/funnelarea/_textfont.py +++ b/plotly/graph_objects/funnelarea/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnelarea/_title.py b/plotly/graph_objects/funnelarea/_title.py index 2a996f10dd..7c63c3ee01 100644 --- a/plotly/graph_objects/funnelarea/_title.py +++ b/plotly/graph_objects/funnelarea/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.funnelarea.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.funnelarea.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def position(self): Specifies the location of the `title`. The 'position' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top left', 'top center', 'top right'] + + - One of the following enumeration values: + + ['top left', 'top center', 'top right'] Returns ------- @@ -57,8 +59,10 @@ def text(self): displayed. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/funnelarea/hoverlabel/_font.py b/plotly/graph_objects/funnelarea/hoverlabel/_font.py index c078c7781d..92836ef646 100644 --- a/plotly/graph_objects/funnelarea/hoverlabel/_font.py +++ b/plotly/graph_objects/funnelarea/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/funnelarea/legendgrouptitle/_font.py b/plotly/graph_objects/funnelarea/legendgrouptitle/_font.py index 789123911c..8119085543 100644 --- a/plotly/graph_objects/funnelarea/legendgrouptitle/_font.py +++ b/plotly/graph_objects/funnelarea/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/funnelarea/marker/_line.py b/plotly/graph_objects/funnelarea/marker/_line.py index 8fe4b4f244..12de8ff37d 100644 --- a/plotly/graph_objects/funnelarea/marker/_line.py +++ b/plotly/graph_objects/funnelarea/marker/_line.py @@ -17,12 +17,13 @@ def color(self): the `paper_bgcolor` value. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,8 +59,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/funnelarea/marker/_pattern.py b/plotly/graph_objects/funnelarea/marker/_pattern.py index 2256681e23..6a74ae9a4d 100644 --- a/plotly/graph_objects/funnelarea/marker/_pattern.py +++ b/plotly/graph_objects/funnelarea/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/funnelarea/title/_font.py b/plotly/graph_objects/funnelarea/title/_font.py index 7a20474917..bc097d8645 100644 --- a/plotly/graph_objects/funnelarea/title/_font.py +++ b/plotly/graph_objects/funnelarea/title/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/heatmap/_colorbar.py b/plotly/graph_objects/heatmap/_colorbar.py index b29d49eecf..83ecb7f6b1 100644 --- a/plotly/graph_objects/heatmap/_colorbar.py +++ b/plotly/graph_objects/heatmap/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.heatmap.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.heatmap.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.heatmap.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.heatmap.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.heatmap.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/heatmap/_hoverlabel.py b/plotly/graph_objects/heatmap/_hoverlabel.py index a4d91a73b9..fdbce03594 100644 --- a/plotly/graph_objects/heatmap/_hoverlabel.py +++ b/plotly/graph_objects/heatmap/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.heatmap.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/heatmap/_legendgrouptitle.py b/plotly/graph_objects/heatmap/_legendgrouptitle.py index d0e05281bd..da1032c1e1 100644 --- a/plotly/graph_objects/heatmap/_legendgrouptitle.py +++ b/plotly/graph_objects/heatmap/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.heatmap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/heatmap/_stream.py b/plotly/graph_objects/heatmap/_stream.py index 364b296e27..bfd013b53a 100644 --- a/plotly/graph_objects/heatmap/_stream.py +++ b/plotly/graph_objects/heatmap/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/heatmap/_textfont.py b/plotly/graph_objects/heatmap/_textfont.py index 259b292a18..aeb335b4b3 100644 --- a/plotly/graph_objects/heatmap/_textfont.py +++ b/plotly/graph_objects/heatmap/_textfont.py @@ -24,11 +24,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/heatmap/colorbar/_tickfont.py b/plotly/graph_objects/heatmap/colorbar/_tickfont.py index 31cb137aeb..bea33a9beb 100644 --- a/plotly/graph_objects/heatmap/colorbar/_tickfont.py +++ b/plotly/graph_objects/heatmap/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/heatmap/colorbar/_tickformatstop.py b/plotly/graph_objects/heatmap/colorbar/_tickformatstop.py index 6ae6a97313..9691d92764 100644 --- a/plotly/graph_objects/heatmap/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/heatmap/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/heatmap/colorbar/_title.py b/plotly/graph_objects/heatmap/colorbar/_title.py index e967c610b6..3dd089bcf4 100644 --- a/plotly/graph_objects/heatmap/colorbar/_title.py +++ b/plotly/graph_objects/heatmap/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.heatmap.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.heatmap.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/heatmap/colorbar/title/_font.py b/plotly/graph_objects/heatmap/colorbar/title/_font.py index 4dff370a45..b228c4f2be 100644 --- a/plotly/graph_objects/heatmap/colorbar/title/_font.py +++ b/plotly/graph_objects/heatmap/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/heatmap/hoverlabel/_font.py b/plotly/graph_objects/heatmap/hoverlabel/_font.py index 508c5a3350..48927ef686 100644 --- a/plotly/graph_objects/heatmap/hoverlabel/_font.py +++ b/plotly/graph_objects/heatmap/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/heatmap/legendgrouptitle/_font.py b/plotly/graph_objects/heatmap/legendgrouptitle/_font.py index 9396f92086..0863303007 100644 --- a/plotly/graph_objects/heatmap/legendgrouptitle/_font.py +++ b/plotly/graph_objects/heatmap/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/_cumulative.py b/plotly/graph_objects/histogram/_cumulative.py index eae8cab2ad..683ac53cee 100644 --- a/plotly/graph_objects/histogram/_cumulative.py +++ b/plotly/graph_objects/histogram/_cumulative.py @@ -21,8 +21,10 @@ def currentbin(self): 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'] + + - One of the following enumeration values: + + ['include', 'exclude', 'half'] Returns ------- @@ -43,8 +45,10 @@ def direction(self): decreases from left to right. The 'direction' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['increasing', 'decreasing'] + + - One of the following enumeration values: + + ['increasing', 'decreasing'] Returns ------- diff --git a/plotly/graph_objects/histogram/_error_x.py b/plotly/graph_objects/histogram/_error_x.py index 092390b019..1b2a8c9f74 100644 --- a/plotly/graph_objects/histogram/_error_x.py +++ b/plotly/graph_objects/histogram/_error_x.py @@ -108,11 +108,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -166,7 +167,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -182,7 +184,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -199,7 +202,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -224,8 +228,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -245,7 +251,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -266,7 +273,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,7 +311,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/histogram/_error_y.py b/plotly/graph_objects/histogram/_error_y.py index 44edc06656..84c3279a7a 100644 --- a/plotly/graph_objects/histogram/_error_y.py +++ b/plotly/graph_objects/histogram/_error_y.py @@ -107,11 +107,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -149,7 +150,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -165,7 +167,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -182,7 +185,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -207,8 +211,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -228,7 +234,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -249,7 +256,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -286,7 +294,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/histogram/_hoverlabel.py b/plotly/graph_objects/histogram/_hoverlabel.py index c4532ec00d..01ca266570 100644 --- a/plotly/graph_objects/histogram/_hoverlabel.py +++ b/plotly/graph_objects/histogram/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/histogram/_insidetextfont.py b/plotly/graph_objects/histogram/_insidetextfont.py index b06ab1f9d2..b11fbc30db 100644 --- a/plotly/graph_objects/histogram/_insidetextfont.py +++ b/plotly/graph_objects/histogram/_insidetextfont.py @@ -24,11 +24,12 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/_legendgrouptitle.py b/plotly/graph_objects/histogram/_legendgrouptitle.py index 5eb952ffe6..15c3d89326 100644 --- a/plotly/graph_objects/histogram/_legendgrouptitle.py +++ b/plotly/graph_objects/histogram/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram/_marker.py b/plotly/graph_objects/histogram/_marker.py index 658a6413fa..f191562e76 100644 --- a/plotly/graph_objects/histogram/_marker.py +++ b/plotly/graph_objects/histogram/_marker.py @@ -85,7 +85,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -108,7 +108,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -130,7 +130,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -151,14 +151,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to histogram.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to histogram.marker.colorscale + - A list or array of any of the above Returns ------- @@ -200,9 +200,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -231,30 +231,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -310,9 +311,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -330,8 +331,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -368,9 +371,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/histogram/_outsidetextfont.py b/plotly/graph_objects/histogram/_outsidetextfont.py index 51f1c9c3c4..198931ec91 100644 --- a/plotly/graph_objects/histogram/_outsidetextfont.py +++ b/plotly/graph_objects/histogram/_outsidetextfont.py @@ -24,11 +24,12 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/_selected.py b/plotly/graph_objects/histogram/_selected.py index bcb0144c02..0a96f3f175 100644 --- a/plotly/graph_objects/histogram/_selected.py +++ b/plotly/graph_objects/histogram/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.histogram.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.histogram.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/histogram/_stream.py b/plotly/graph_objects/histogram/_stream.py index b17ee1cff8..03cd54ba5f 100644 --- a/plotly/graph_objects/histogram/_stream.py +++ b/plotly/graph_objects/histogram/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/histogram/_textfont.py b/plotly/graph_objects/histogram/_textfont.py index 2884f35acb..7afdb7e73a 100644 --- a/plotly/graph_objects/histogram/_textfont.py +++ b/plotly/graph_objects/histogram/_textfont.py @@ -24,11 +24,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/_unselected.py b/plotly/graph_objects/histogram/_unselected.py index 6fb98133dc..961b7c41ca 100644 --- a/plotly/graph_objects/histogram/_unselected.py +++ b/plotly/graph_objects/histogram/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.histogram.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.histogram.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/histogram/hoverlabel/_font.py b/plotly/graph_objects/histogram/hoverlabel/_font.py index 60a7a508dc..d72e7c427d 100644 --- a/plotly/graph_objects/histogram/hoverlabel/_font.py +++ b/plotly/graph_objects/histogram/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/histogram/legendgrouptitle/_font.py b/plotly/graph_objects/histogram/legendgrouptitle/_font.py index fa4090d12f..0c685feeba 100644 --- a/plotly/graph_objects/histogram/legendgrouptitle/_font.py +++ b/plotly/graph_objects/histogram/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/marker/_colorbar.py b/plotly/graph_objects/histogram/marker/_colorbar.py index bd8c3926b4..c9a6c4984f 100644 --- a/plotly/graph_objects/histogram/marker/_colorbar.py +++ b/plotly/graph_objects/histogram/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.histogram.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.histogram.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/histogram/marker/_line.py b/plotly/graph_objects/histogram/marker/_line.py index 8ffe3cd97f..a801d574aa 100644 --- a/plotly/graph_objects/histogram/marker/_line.py +++ b/plotly/graph_objects/histogram/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to histogram.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/histogram/marker/_pattern.py b/plotly/graph_objects/histogram/marker/_pattern.py index 18a57eb3bd..e9ba47cffe 100644 --- a/plotly/graph_objects/histogram/marker/_pattern.py +++ b/plotly/graph_objects/histogram/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/histogram/marker/colorbar/_tickfont.py b/plotly/graph_objects/histogram/marker/colorbar/_tickfont.py index a0e554bfdf..841c8a84b8 100644 --- a/plotly/graph_objects/histogram/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/histogram/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/histogram/marker/colorbar/_tickformatstop.py index 0f7aed6588..93dcaa7afb 100644 --- a/plotly/graph_objects/histogram/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/histogram/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram/marker/colorbar/_title.py b/plotly/graph_objects/histogram/marker/colorbar/_title.py index aa9059bfdf..14b4cc298d 100644 --- a/plotly/graph_objects/histogram/marker/colorbar/_title.py +++ b/plotly/graph_objects/histogram/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram/marker/colorbar/title/_font.py b/plotly/graph_objects/histogram/marker/colorbar/title/_font.py index cba9055e16..35e3b66f2e 100644 --- a/plotly/graph_objects/histogram/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/histogram/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram/selected/_marker.py b/plotly/graph_objects/histogram/selected/_marker.py index 05b444cdeb..2cc7844a13 100644 --- a/plotly/graph_objects/histogram/selected/_marker.py +++ b/plotly/graph_objects/histogram/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/histogram/selected/_textfont.py b/plotly/graph_objects/histogram/selected/_textfont.py index 58e58dd86a..eae60788ea 100644 --- a/plotly/graph_objects/histogram/selected/_textfont.py +++ b/plotly/graph_objects/histogram/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/histogram/unselected/_marker.py b/plotly/graph_objects/histogram/unselected/_marker.py index 8a3e50ed65..a29a92650c 100644 --- a/plotly/graph_objects/histogram/unselected/_marker.py +++ b/plotly/graph_objects/histogram/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/histogram/unselected/_textfont.py b/plotly/graph_objects/histogram/unselected/_textfont.py index 9cfb88488c..42285e5565 100644 --- a/plotly/graph_objects/histogram/unselected/_textfont.py +++ b/plotly/graph_objects/histogram/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/histogram2d/_colorbar.py b/plotly/graph_objects/histogram2d/_colorbar.py index 8d0a75018e..b960831854 100644 --- a/plotly/graph_objects/histogram2d/_colorbar.py +++ b/plotly/graph_objects/histogram2d/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.histogram2d.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.histogram2d.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/histogram2d/_hoverlabel.py b/plotly/graph_objects/histogram2d/_hoverlabel.py index 3fa609f61f..2baf3e84bc 100644 --- a/plotly/graph_objects/histogram2d/_hoverlabel.py +++ b/plotly/graph_objects/histogram2d/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/histogram2d/_legendgrouptitle.py b/plotly/graph_objects/histogram2d/_legendgrouptitle.py index ed054ba609..53222b9591 100644 --- a/plotly/graph_objects/histogram2d/_legendgrouptitle.py +++ b/plotly/graph_objects/histogram2d/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram2d/_stream.py b/plotly/graph_objects/histogram2d/_stream.py index b572eb4de0..7a40dfa631 100644 --- a/plotly/graph_objects/histogram2d/_stream.py +++ b/plotly/graph_objects/histogram2d/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/histogram2d/_textfont.py b/plotly/graph_objects/histogram2d/_textfont.py index 12d26730b7..c134e83274 100644 --- a/plotly/graph_objects/histogram2d/_textfont.py +++ b/plotly/graph_objects/histogram2d/_textfont.py @@ -24,11 +24,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2d/colorbar/_tickfont.py b/plotly/graph_objects/histogram2d/colorbar/_tickfont.py index f57fcb48da..c278acd2af 100644 --- a/plotly/graph_objects/histogram2d/colorbar/_tickfont.py +++ b/plotly/graph_objects/histogram2d/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2d/colorbar/_tickformatstop.py b/plotly/graph_objects/histogram2d/colorbar/_tickformatstop.py index 3a5ea0580a..e4406eaa54 100644 --- a/plotly/graph_objects/histogram2d/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/histogram2d/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram2d/colorbar/_title.py b/plotly/graph_objects/histogram2d/colorbar/_title.py index f873d8a932..c6b6bca2fe 100644 --- a/plotly/graph_objects/histogram2d/colorbar/_title.py +++ b/plotly/graph_objects/histogram2d/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram2d.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram2d/colorbar/title/_font.py b/plotly/graph_objects/histogram2d/colorbar/title/_font.py index 6161d53924..5e6301b997 100644 --- a/plotly/graph_objects/histogram2d/colorbar/title/_font.py +++ b/plotly/graph_objects/histogram2d/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2d/hoverlabel/_font.py b/plotly/graph_objects/histogram2d/hoverlabel/_font.py index 1288c4f030..d636a96bc5 100644 --- a/plotly/graph_objects/histogram2d/hoverlabel/_font.py +++ b/plotly/graph_objects/histogram2d/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/histogram2d/legendgrouptitle/_font.py b/plotly/graph_objects/histogram2d/legendgrouptitle/_font.py index 7d47938acb..defda5f79f 100644 --- a/plotly/graph_objects/histogram2d/legendgrouptitle/_font.py +++ b/plotly/graph_objects/histogram2d/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2dcontour/_colorbar.py b/plotly/graph_objects/histogram2dcontour/_colorbar.py index 50e4a79bc2..af15821a5e 100644 --- a/plotly/graph_objects/histogram2dcontour/_colorbar.py +++ b/plotly/graph_objects/histogram2dcontour/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.histogram2dcontour.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.histogram2dcontour.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/_contours.py b/plotly/graph_objects/histogram2dcontour/_contours.py index 437c0dbafa..a28bdcc310 100644 --- a/plotly/graph_objects/histogram2dcontour/_contours.py +++ b/plotly/graph_objects/histogram2dcontour/_contours.py @@ -32,8 +32,10 @@ def coloring(self): 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'] + + - One of the following enumeration values: + + ['fill', 'heatmap', 'lines', 'none'] Returns ------- @@ -53,7 +55,7 @@ def end(self): The 'end' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -74,9 +76,9 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.contours.Labelfont` - - A dict of string/value properties that will be passed - to the Labelfont constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.contours.Labelfont` + - A dict of string/value properties that will be passed to the Labelfont constructor Returns ------- @@ -97,8 +99,10 @@ def labelformat(self): https://github.com/d3/d3-format/tree/v1.4.5#d3-format. The 'labelformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -123,9 +127,11 @@ def operation(self): transforms. The 'operation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')['] + + - One of the following enumeration values: + + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] Returns ------- @@ -181,7 +187,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -201,7 +208,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,8 +229,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['levels', 'constraint'] Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/_hoverlabel.py b/plotly/graph_objects/histogram2dcontour/_hoverlabel.py index 08eaa835d0..acf2f31af1 100644 --- a/plotly/graph_objects/histogram2dcontour/_hoverlabel.py +++ b/plotly/graph_objects/histogram2dcontour/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/histogram2dcontour/_legendgrouptitle.py b/plotly/graph_objects/histogram2dcontour/_legendgrouptitle.py index 6c00b9ea8d..07e7e766b1 100644 --- a/plotly/graph_objects/histogram2dcontour/_legendgrouptitle.py +++ b/plotly/graph_objects/histogram2dcontour/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/_line.py b/plotly/graph_objects/histogram2dcontour/_line.py index b82a2b30d1..c11024a9f3 100644 --- a/plotly/graph_objects/histogram2dcontour/_line.py +++ b/plotly/graph_objects/histogram2dcontour/_line.py @@ -17,11 +17,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,10 +43,14 @@ def dash(self): "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.) + + - 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 ------- @@ -64,7 +69,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -82,7 +88,8 @@ def width(self): Sets the contour line width in (in px) The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/_stream.py b/plotly/graph_objects/histogram2dcontour/_stream.py index c4a8a2da7a..8945036657 100644 --- a/plotly/graph_objects/histogram2dcontour/_stream.py +++ b/plotly/graph_objects/histogram2dcontour/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/_textfont.py b/plotly/graph_objects/histogram2dcontour/_textfont.py index 098c5e7cf4..de33b64114 100644 --- a/plotly/graph_objects/histogram2dcontour/_textfont.py +++ b/plotly/graph_objects/histogram2dcontour/_textfont.py @@ -24,11 +24,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2dcontour/colorbar/_tickfont.py b/plotly/graph_objects/histogram2dcontour/colorbar/_tickfont.py index 6a832cb0fe..18ef8e3dc4 100644 --- a/plotly/graph_objects/histogram2dcontour/colorbar/_tickfont.py +++ b/plotly/graph_objects/histogram2dcontour/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2dcontour/colorbar/_tickformatstop.py b/plotly/graph_objects/histogram2dcontour/colorbar/_tickformatstop.py index 483bb99d0d..c65ca5e98c 100644 --- a/plotly/graph_objects/histogram2dcontour/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/histogram2dcontour/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/colorbar/_title.py b/plotly/graph_objects/histogram2dcontour/colorbar/_title.py index 67e83d2a2b..358f2fb386 100644 --- a/plotly/graph_objects/histogram2dcontour/colorbar/_title.py +++ b/plotly/graph_objects/histogram2dcontour/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.histogram2dcontour.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/histogram2dcontour/colorbar/title/_font.py b/plotly/graph_objects/histogram2dcontour/colorbar/title/_font.py index 9d281b93b1..308f423694 100644 --- a/plotly/graph_objects/histogram2dcontour/colorbar/title/_font.py +++ b/plotly/graph_objects/histogram2dcontour/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2dcontour/contours/_labelfont.py b/plotly/graph_objects/histogram2dcontour/contours/_labelfont.py index 6383a3fa79..b7279c3231 100644 --- a/plotly/graph_objects/histogram2dcontour/contours/_labelfont.py +++ b/plotly/graph_objects/histogram2dcontour/contours/_labelfont.py @@ -24,11 +24,12 @@ class Labelfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/histogram2dcontour/hoverlabel/_font.py b/plotly/graph_objects/histogram2dcontour/hoverlabel/_font.py index d71d9284a8..257daafa50 100644 --- a/plotly/graph_objects/histogram2dcontour/hoverlabel/_font.py +++ b/plotly/graph_objects/histogram2dcontour/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/histogram2dcontour/legendgrouptitle/_font.py b/plotly/graph_objects/histogram2dcontour/legendgrouptitle/_font.py index cf23ade7d2..724f706c2f 100644 --- a/plotly/graph_objects/histogram2dcontour/legendgrouptitle/_font.py +++ b/plotly/graph_objects/histogram2dcontour/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/icicle/_domain.py b/plotly/graph_objects/icicle/_domain.py index 1d160d6548..59e20e31e0 100644 --- a/plotly/graph_objects/icicle/_domain.py +++ b/plotly/graph_objects/icicle/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this icicle trace . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this icicle trace . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/icicle/_hoverlabel.py b/plotly/graph_objects/icicle/_hoverlabel.py index 8b6c52e755..360f382748 100644 --- a/plotly/graph_objects/icicle/_hoverlabel.py +++ b/plotly/graph_objects/icicle/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.icicle.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/icicle/_insidetextfont.py b/plotly/graph_objects/icicle/_insidetextfont.py index 1bea15c764..e0dab2a368 100644 --- a/plotly/graph_objects/icicle/_insidetextfont.py +++ b/plotly/graph_objects/icicle/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/icicle/_leaf.py b/plotly/graph_objects/icicle/_leaf.py index 4b72dfd410..f2869343e8 100644 --- a/plotly/graph_objects/icicle/_leaf.py +++ b/plotly/graph_objects/icicle/_leaf.py @@ -17,7 +17,8 @@ def opacity(self): to 1; otherwise it is defaulted to 0.7 The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/icicle/_legendgrouptitle.py b/plotly/graph_objects/icicle/_legendgrouptitle.py index 3c66f13543..5b39fedada 100644 --- a/plotly/graph_objects/icicle/_legendgrouptitle.py +++ b/plotly/graph_objects/icicle/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.icicle.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/icicle/_marker.py b/plotly/graph_objects/icicle/_marker.py index c703919f14..d894c09755 100644 --- a/plotly/graph_objects/icicle/_marker.py +++ b/plotly/graph_objects/icicle/_marker.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -103,7 +103,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -124,7 +124,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -166,9 +166,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -216,30 +216,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -274,9 +275,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -295,9 +296,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/icicle/_outsidetextfont.py b/plotly/graph_objects/icicle/_outsidetextfont.py index fae078fad5..ad4c665609 100644 --- a/plotly/graph_objects/icicle/_outsidetextfont.py +++ b/plotly/graph_objects/icicle/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/icicle/_pathbar.py b/plotly/graph_objects/icicle/_pathbar.py index dc3b0d987b..1db6336f8f 100644 --- a/plotly/graph_objects/icicle/_pathbar.py +++ b/plotly/graph_objects/icicle/_pathbar.py @@ -17,8 +17,10 @@ def edgeshape(self): labels. The 'edgeshape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['>', '<', '|', '/', '\\'] + + - One of the following enumeration values: + + ['>', '<', '|', '/', '\\'] Returns ------- @@ -37,8 +39,10 @@ def side(self): should be presented. The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'bottom'] + + - One of the following enumeration values: + + ['top', 'bottom'] Returns ------- @@ -57,9 +61,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.pathbar.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.icicle.pathbar.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -79,7 +83,8 @@ def thickness(self): each side. The 'thickness' property is a number and may be specified as: - - An int or float in the interval [12, inf] + + - An int or float in the interval [12, inf] Returns ------- diff --git a/plotly/graph_objects/icicle/_root.py b/plotly/graph_objects/icicle/_root.py index ae1373c28b..50d707c795 100644 --- a/plotly/graph_objects/icicle/_root.py +++ b/plotly/graph_objects/icicle/_root.py @@ -18,11 +18,12 @@ def color(self): markers. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/icicle/_stream.py b/plotly/graph_objects/icicle/_stream.py index d57f0cd01f..2e6cab1e13 100644 --- a/plotly/graph_objects/icicle/_stream.py +++ b/plotly/graph_objects/icicle/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/icicle/_textfont.py b/plotly/graph_objects/icicle/_textfont.py index 0942dc3e94..8f511dd105 100644 --- a/plotly/graph_objects/icicle/_textfont.py +++ b/plotly/graph_objects/icicle/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/icicle/_tiling.py b/plotly/graph_objects/icicle/_tiling.py index 2331959106..c837f8f623 100644 --- a/plotly/graph_objects/icicle/_tiling.py +++ b/plotly/graph_objects/icicle/_tiling.py @@ -18,7 +18,8 @@ def flip(self): The 'flip' property is a flaglist and may be specified as a string containing: - - Any combination of ['x', 'y'] joined with '+' characters + + - Any combination of ['x', 'y'] joined with '+' characters (e.g. 'x+y') Returns @@ -44,8 +45,10 @@ def orientation(self): `tiling.flip` is "x", the root nodes appear at the right. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['v', 'h'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -63,7 +66,8 @@ def pad(self): Sets the inner padding (in px). The 'pad' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/icicle/hoverlabel/_font.py b/plotly/graph_objects/icicle/hoverlabel/_font.py index ea6d266b29..a165b95fcd 100644 --- a/plotly/graph_objects/icicle/hoverlabel/_font.py +++ b/plotly/graph_objects/icicle/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/icicle/legendgrouptitle/_font.py b/plotly/graph_objects/icicle/legendgrouptitle/_font.py index bcbd7e5ca3..320ef8adc6 100644 --- a/plotly/graph_objects/icicle/legendgrouptitle/_font.py +++ b/plotly/graph_objects/icicle/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/icicle/marker/_colorbar.py b/plotly/graph_objects/icicle/marker/_colorbar.py index 1ce3caa41e..fa0d2b8936 100644 --- a/plotly/graph_objects/icicle/marker/_colorbar.py +++ b/plotly/graph_objects/icicle/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.icicle.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.icicle.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/icicle/marker/_line.py b/plotly/graph_objects/icicle/marker/_line.py index ae6632ac38..652a7b9192 100644 --- a/plotly/graph_objects/icicle/marker/_line.py +++ b/plotly/graph_objects/icicle/marker/_line.py @@ -17,12 +17,13 @@ def color(self): the `paper_bgcolor` value. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,8 +59,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/icicle/marker/_pattern.py b/plotly/graph_objects/icicle/marker/_pattern.py index f335b645f7..8b9a32d153 100644 --- a/plotly/graph_objects/icicle/marker/_pattern.py +++ b/plotly/graph_objects/icicle/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/icicle/marker/colorbar/_tickfont.py b/plotly/graph_objects/icicle/marker/colorbar/_tickfont.py index 6b65471bcf..1c88ab7d63 100644 --- a/plotly/graph_objects/icicle/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/icicle/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/icicle/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/icicle/marker/colorbar/_tickformatstop.py index 967f5dd9da..eb35b8f74d 100644 --- a/plotly/graph_objects/icicle/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/icicle/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/icicle/marker/colorbar/_title.py b/plotly/graph_objects/icicle/marker/colorbar/_title.py index d893f51ca1..7f5d52a7a8 100644 --- a/plotly/graph_objects/icicle/marker/colorbar/_title.py +++ b/plotly/graph_objects/icicle/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.icicle.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/icicle/marker/colorbar/title/_font.py b/plotly/graph_objects/icicle/marker/colorbar/title/_font.py index 209683a1df..9bba4cebfe 100644 --- a/plotly/graph_objects/icicle/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/icicle/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/icicle/pathbar/_textfont.py b/plotly/graph_objects/icicle/pathbar/_textfont.py index 7011269e70..5b21401337 100644 --- a/plotly/graph_objects/icicle/pathbar/_textfont.py +++ b/plotly/graph_objects/icicle/pathbar/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/image/_hoverlabel.py b/plotly/graph_objects/image/_hoverlabel.py index e9a317645b..ff898941bd 100644 --- a/plotly/graph_objects/image/_hoverlabel.py +++ b/plotly/graph_objects/image/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.image.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.image.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/image/_legendgrouptitle.py b/plotly/graph_objects/image/_legendgrouptitle.py index c251d431f6..7b13ab373c 100644 --- a/plotly/graph_objects/image/_legendgrouptitle.py +++ b/plotly/graph_objects/image/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.image.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.image.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/image/_stream.py b/plotly/graph_objects/image/_stream.py index 5bbc921d90..33b1df150e 100644 --- a/plotly/graph_objects/image/_stream.py +++ b/plotly/graph_objects/image/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/image/hoverlabel/_font.py b/plotly/graph_objects/image/hoverlabel/_font.py index 5ce4dc71db..6ea2d7c86b 100644 --- a/plotly/graph_objects/image/hoverlabel/_font.py +++ b/plotly/graph_objects/image/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/image/legendgrouptitle/_font.py b/plotly/graph_objects/image/legendgrouptitle/_font.py index 3f1d31e835..aab059460e 100644 --- a/plotly/graph_objects/image/legendgrouptitle/_font.py +++ b/plotly/graph_objects/image/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/indicator/_delta.py b/plotly/graph_objects/indicator/_delta.py index 30fa90a933..7ce3208b19 100644 --- a/plotly/graph_objects/indicator/_delta.py +++ b/plotly/graph_objects/indicator/_delta.py @@ -25,9 +25,9 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.delta.Decreasing` - - A dict of string/value properties that will be passed - to the Decreasing constructor + + - An instance of :class:`plotly.graph_objects.indicator.delta.Decreasing` + - A dict of string/value properties that will be passed to the Decreasing constructor Returns ------- @@ -46,9 +46,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.delta.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.indicator.delta.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -65,9 +65,9 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.delta.Increasing` - - A dict of string/value properties that will be passed - to the Increasing constructor + + - An instance of :class:`plotly.graph_objects.indicator.delta.Increasing` + - A dict of string/value properties that will be passed to the Increasing constructor Returns ------- @@ -85,8 +85,10 @@ def position(self): Sets the position of delta with respect to the number. The 'position' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'bottom', 'left', 'right'] + + - One of the following enumeration values: + + ['top', 'bottom', 'left', 'right'] Returns ------- @@ -104,8 +106,10 @@ def prefix(self): Sets a prefix appearing before the delta. The 'prefix' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -125,7 +129,7 @@ def reference(self): The 'reference' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -161,8 +165,10 @@ def suffix(self): Sets a suffix appearing next to the delta. The 'suffix' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -183,8 +189,10 @@ def valueformat(self): https://github.com/d3/d3-format/tree/v1.4.5#d3-format. The 'valueformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/_domain.py b/plotly/graph_objects/indicator/_domain.py index 344a3f25db..c511f3decd 100644 --- a/plotly/graph_objects/indicator/_domain.py +++ b/plotly/graph_objects/indicator/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this indicator trace . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this indicator trace . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/indicator/_gauge.py b/plotly/graph_objects/indicator/_gauge.py index a1b76735ee..e41ef8cee1 100644 --- a/plotly/graph_objects/indicator/_gauge.py +++ b/plotly/graph_objects/indicator/_gauge.py @@ -25,9 +25,9 @@ def axis(self): """ The 'axis' property is an instance of Axis that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.Axis` - - A dict of string/value properties that will be passed - to the Axis constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.Axis` + - A dict of string/value properties that will be passed to the Axis constructor Returns ------- @@ -46,9 +46,9 @@ def bar(self): The 'bar' property is an instance of Bar that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.Bar` - - A dict of string/value properties that will be passed - to the Bar constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.Bar` + - A dict of string/value properties that will be passed to the Bar constructor Returns ------- @@ -66,11 +66,12 @@ def bgcolor(self): Sets the gauge background color. The 'bgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ def bordercolor(self): Sets the color of the border enclosing the gauge. The 'bordercolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ def borderwidth(self): Sets the width (in px) of the border enclosing the gauge. The 'borderwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -128,8 +131,10 @@ def shape(self): Set the shape of the gauge The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['angular', 'bullet'] + + - One of the following enumeration values: + + ['angular', 'bullet'] Returns ------- @@ -146,8 +151,9 @@ 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_objects.indicator.gauge.Step - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.indicator.gauge.Step + - A list or tuple of dicts of string/value properties that will be passed to the Step constructor Returns @@ -170,9 +176,9 @@ def stepdefaults(self): The 'stepdefaults' property is an instance of Step that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.Step` - - A dict of string/value properties that will be passed - to the Step constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.Step` + - A dict of string/value properties that will be passed to the Step constructor Returns ------- @@ -189,9 +195,9 @@ def threshold(self): """ The 'threshold' property is an instance of Threshold that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.Threshold` - - A dict of string/value properties that will be passed - to the Threshold constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.Threshold` + - A dict of string/value properties that will be passed to the Threshold constructor Returns ------- diff --git a/plotly/graph_objects/indicator/_legendgrouptitle.py b/plotly/graph_objects/indicator/_legendgrouptitle.py index cfb6561f21..185ffffcbb 100644 --- a/plotly/graph_objects/indicator/_legendgrouptitle.py +++ b/plotly/graph_objects/indicator/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.indicator.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/_number.py b/plotly/graph_objects/indicator/_number.py index 54b74ee0bd..7699fcd656 100644 --- a/plotly/graph_objects/indicator/_number.py +++ b/plotly/graph_objects/indicator/_number.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.number.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.indicator.number.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def prefix(self): Sets a prefix appearing before the number. The 'prefix' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -56,8 +58,10 @@ def suffix(self): Sets a suffix appearing next to the number. The 'suffix' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -78,8 +82,10 @@ def valueformat(self): https://github.com/d3/d3-format/tree/v1.4.5#d3-format. The 'valueformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/_stream.py b/plotly/graph_objects/indicator/_stream.py index 0f8288568f..534dbdb94c 100644 --- a/plotly/graph_objects/indicator/_stream.py +++ b/plotly/graph_objects/indicator/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/indicator/_title.py b/plotly/graph_objects/indicator/_title.py index 2315ec9d4f..9da3c4914c 100644 --- a/plotly/graph_objects/indicator/_title.py +++ b/plotly/graph_objects/indicator/_title.py @@ -18,8 +18,10 @@ def align(self): right. The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -38,9 +40,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.indicator.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of this indicator. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/delta/_decreasing.py b/plotly/graph_objects/indicator/delta/_decreasing.py index 80b2b573a6..e2524ea56e 100644 --- a/plotly/graph_objects/indicator/delta/_decreasing.py +++ b/plotly/graph_objects/indicator/delta/_decreasing.py @@ -16,11 +16,12 @@ def color(self): Sets the color for increasing value. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,8 +39,10 @@ def symbol(self): Sets the symbol to display for increasing value The 'symbol' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/delta/_font.py b/plotly/graph_objects/indicator/delta/_font.py index f1de630996..355430077a 100644 --- a/plotly/graph_objects/indicator/delta/_font.py +++ b/plotly/graph_objects/indicator/delta/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/indicator/delta/_increasing.py b/plotly/graph_objects/indicator/delta/_increasing.py index ce40cdda12..3fdc6b67d2 100644 --- a/plotly/graph_objects/indicator/delta/_increasing.py +++ b/plotly/graph_objects/indicator/delta/_increasing.py @@ -16,11 +16,12 @@ def color(self): Sets the color for increasing value. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,8 +39,10 @@ def symbol(self): Sets the symbol to display for increasing value The 'symbol' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/_axis.py b/plotly/graph_objects/indicator/gauge/_axis.py index ff454f8fae..88499511b1 100644 --- a/plotly/graph_objects/indicator/gauge/_axis.py +++ b/plotly/graph_objects/indicator/gauge/_axis.py @@ -87,8 +87,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -132,7 +134,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -153,7 +156,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -220,8 +224,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -260,8 +266,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -279,8 +287,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -345,11 +355,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -368,9 +379,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.axis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.axis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -397,8 +408,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -415,8 +428,9 @@ 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_objects.indicator.gauge.axis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.indicator.gauge.axis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -439,9 +453,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.axis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.axis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -464,7 +478,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -483,7 +498,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -507,8 +523,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -526,8 +544,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -547,8 +567,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -566,8 +588,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -660,7 +684,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/_bar.py b/plotly/graph_objects/indicator/gauge/_bar.py index b2e29b1d3a..f94a6ae06f 100644 --- a/plotly/graph_objects/indicator/gauge/_bar.py +++ b/plotly/graph_objects/indicator/gauge/_bar.py @@ -16,11 +16,12 @@ def color(self): Sets the background color of the arc. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.bar.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.bar.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -58,7 +59,8 @@ def thickness(self): thickness of the gauge. The 'thickness' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/_step.py b/plotly/graph_objects/indicator/gauge/_step.py index 81571c8880..5d2ea54be4 100644 --- a/plotly/graph_objects/indicator/gauge/_step.py +++ b/plotly/graph_objects/indicator/gauge/_step.py @@ -16,11 +16,12 @@ def color(self): Sets the background color of the arc. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.step.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.step.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -63,8 +64,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -116,8 +119,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -136,7 +141,8 @@ def thickness(self): thickness of the gauge. The 'thickness' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/_threshold.py b/plotly/graph_objects/indicator/gauge/_threshold.py index 39d696b2e5..bec36fc3f3 100644 --- a/plotly/graph_objects/indicator/gauge/_threshold.py +++ b/plotly/graph_objects/indicator/gauge/_threshold.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.indicator.gauge.threshold.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.indicator.gauge.threshold.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -36,7 +36,8 @@ def thickness(self): thickness of the gauge. The 'thickness' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -55,7 +56,7 @@ def value(self): The 'value' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/axis/_tickfont.py b/plotly/graph_objects/indicator/gauge/axis/_tickfont.py index f4cb654127..370f8045da 100644 --- a/plotly/graph_objects/indicator/gauge/axis/_tickfont.py +++ b/plotly/graph_objects/indicator/gauge/axis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/indicator/gauge/axis/_tickformatstop.py b/plotly/graph_objects/indicator/gauge/axis/_tickformatstop.py index fe479ae15d..8b2dc99bdb 100644 --- a/plotly/graph_objects/indicator/gauge/axis/_tickformatstop.py +++ b/plotly/graph_objects/indicator/gauge/axis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/bar/_line.py b/plotly/graph_objects/indicator/gauge/bar/_line.py index b6f1514245..ddadb38fd2 100644 --- a/plotly/graph_objects/indicator/gauge/bar/_line.py +++ b/plotly/graph_objects/indicator/gauge/bar/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/step/_line.py b/plotly/graph_objects/indicator/gauge/step/_line.py index 6b1f56d87e..0639fcd82b 100644 --- a/plotly/graph_objects/indicator/gauge/step/_line.py +++ b/plotly/graph_objects/indicator/gauge/step/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/indicator/gauge/threshold/_line.py b/plotly/graph_objects/indicator/gauge/threshold/_line.py index 472c15a413..75d21fe656 100644 --- a/plotly/graph_objects/indicator/gauge/threshold/_line.py +++ b/plotly/graph_objects/indicator/gauge/threshold/_line.py @@ -16,11 +16,12 @@ def color(self): Sets the color of the threshold line. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ def width(self): Sets the width (in px) of the threshold line. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/indicator/legendgrouptitle/_font.py b/plotly/graph_objects/indicator/legendgrouptitle/_font.py index 2e611911c4..6b3854c33a 100644 --- a/plotly/graph_objects/indicator/legendgrouptitle/_font.py +++ b/plotly/graph_objects/indicator/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/indicator/number/_font.py b/plotly/graph_objects/indicator/number/_font.py index 4880c91119..1b3c97515c 100644 --- a/plotly/graph_objects/indicator/number/_font.py +++ b/plotly/graph_objects/indicator/number/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/indicator/title/_font.py b/plotly/graph_objects/indicator/title/_font.py index 8b8cb6c937..608b5c793f 100644 --- a/plotly/graph_objects/indicator/title/_font.py +++ b/plotly/graph_objects/indicator/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/isosurface/_caps.py b/plotly/graph_objects/isosurface/_caps.py index fb5b7b50f8..2839de8429 100644 --- a/plotly/graph_objects/isosurface/_caps.py +++ b/plotly/graph_objects/isosurface/_caps.py @@ -15,9 +15,9 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.caps.X` - - A dict of string/value properties that will be passed - to the X constructor + + - An instance of :class:`plotly.graph_objects.isosurface.caps.X` + - A dict of string/value properties that will be passed to the X constructor Returns ------- @@ -34,9 +34,9 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.caps.Y` - - A dict of string/value properties that will be passed - to the Y constructor + + - An instance of :class:`plotly.graph_objects.isosurface.caps.Y` + - A dict of string/value properties that will be passed to the Y constructor Returns ------- @@ -53,9 +53,9 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.caps.Z` - - A dict of string/value properties that will be passed - to the Z constructor + + - An instance of :class:`plotly.graph_objects.isosurface.caps.Z` + - A dict of string/value properties that will be passed to the Z constructor Returns ------- diff --git a/plotly/graph_objects/isosurface/_colorbar.py b/plotly/graph_objects/isosurface/_colorbar.py index cef04117e2..06675e8ff1 100644 --- a/plotly/graph_objects/isosurface/_colorbar.py +++ b/plotly/graph_objects/isosurface/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.isosurface.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.isosurface.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.isosurface.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -632,9 +659,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.isosurface.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -655,8 +682,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -676,10 +705,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -702,7 +733,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -721,7 +753,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -745,8 +778,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -764,8 +799,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -785,8 +822,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -804,8 +843,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -898,7 +939,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -915,9 +957,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.isosurface.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -942,7 +984,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,8 +1005,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -982,7 +1026,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1002,8 +1047,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1028,7 +1075,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1049,8 +1096,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1068,7 +1117,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1088,8 +1138,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/isosurface/_contour.py b/plotly/graph_objects/isosurface/_contour.py index 8a4b68853f..dfbfb2b84e 100644 --- a/plotly/graph_objects/isosurface/_contour.py +++ b/plotly/graph_objects/isosurface/_contour.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -56,7 +57,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- diff --git a/plotly/graph_objects/isosurface/_hoverlabel.py b/plotly/graph_objects/isosurface/_hoverlabel.py index 0e1f4ad3d4..2c78f2a0c3 100644 --- a/plotly/graph_objects/isosurface/_hoverlabel.py +++ b/plotly/graph_objects/isosurface/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.isosurface.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/isosurface/_legendgrouptitle.py b/plotly/graph_objects/isosurface/_legendgrouptitle.py index a55b0b442c..d08bba1f28 100644 --- a/plotly/graph_objects/isosurface/_legendgrouptitle.py +++ b/plotly/graph_objects/isosurface/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.isosurface.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/isosurface/_lighting.py b/plotly/graph_objects/isosurface/_lighting.py index 0069991100..add9eae0e8 100644 --- a/plotly/graph_objects/isosurface/_lighting.py +++ b/plotly/graph_objects/isosurface/_lighting.py @@ -25,7 +25,8 @@ def ambient(self): out the image. The 'ambient' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -44,7 +45,8 @@ def diffuse(self): range of angles. The 'diffuse' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -63,7 +65,8 @@ def facenormalsepsilon(self): from degenerate geometry. The 'facenormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -83,7 +86,8 @@ def fresnel(self): 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] + + - An int or float in the interval [0, 5] Returns ------- @@ -102,7 +106,8 @@ def roughness(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -121,7 +126,8 @@ def specular(self): single direction, causing shine. The 'specular' property is a number and may be specified as: - - An int or float in the interval [0, 2] + + - An int or float in the interval [0, 2] Returns ------- @@ -140,7 +146,8 @@ def vertexnormalsepsilon(self): arising from degenerate geometry. The 'vertexnormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/_lightposition.py b/plotly/graph_objects/isosurface/_lightposition.py index e97807ab77..25ac6d90b5 100644 --- a/plotly/graph_objects/isosurface/_lightposition.py +++ b/plotly/graph_objects/isosurface/_lightposition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -34,7 +35,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -52,7 +54,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- diff --git a/plotly/graph_objects/isosurface/_slices.py b/plotly/graph_objects/isosurface/_slices.py index 7f9dc90527..0e290011a6 100644 --- a/plotly/graph_objects/isosurface/_slices.py +++ b/plotly/graph_objects/isosurface/_slices.py @@ -15,9 +15,9 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.slices.X` - - A dict of string/value properties that will be passed - to the X constructor + + - An instance of :class:`plotly.graph_objects.isosurface.slices.X` + - A dict of string/value properties that will be passed to the X constructor Returns ------- @@ -34,9 +34,9 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.slices.Y` - - A dict of string/value properties that will be passed - to the Y constructor + + - An instance of :class:`plotly.graph_objects.isosurface.slices.Y` + - A dict of string/value properties that will be passed to the Y constructor Returns ------- @@ -53,9 +53,9 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.slices.Z` - - A dict of string/value properties that will be passed - to the Z constructor + + - An instance of :class:`plotly.graph_objects.isosurface.slices.Z` + - A dict of string/value properties that will be passed to the Z constructor Returns ------- diff --git a/plotly/graph_objects/isosurface/_spaceframe.py b/plotly/graph_objects/isosurface/_spaceframe.py index db178cef55..ea6e91ac3d 100644 --- a/plotly/graph_objects/isosurface/_spaceframe.py +++ b/plotly/graph_objects/isosurface/_spaceframe.py @@ -20,7 +20,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/_stream.py b/plotly/graph_objects/isosurface/_stream.py index b3ded8a205..615f5ad7bc 100644 --- a/plotly/graph_objects/isosurface/_stream.py +++ b/plotly/graph_objects/isosurface/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/isosurface/_surface.py b/plotly/graph_objects/isosurface/_surface.py index cba429f1aa..9189075363 100644 --- a/plotly/graph_objects/isosurface/_surface.py +++ b/plotly/graph_objects/isosurface/_surface.py @@ -18,7 +18,8 @@ def count(self): 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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -40,7 +41,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -65,7 +67,8 @@ def pattern(self): 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 + + - 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') diff --git a/plotly/graph_objects/isosurface/caps/_x.py b/plotly/graph_objects/isosurface/caps/_x.py index 6fcac5373d..9b24eb21c1 100644 --- a/plotly/graph_objects/isosurface/caps/_x.py +++ b/plotly/graph_objects/isosurface/caps/_x.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/caps/_y.py b/plotly/graph_objects/isosurface/caps/_y.py index f0444125f6..88ff82d511 100644 --- a/plotly/graph_objects/isosurface/caps/_y.py +++ b/plotly/graph_objects/isosurface/caps/_y.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/caps/_z.py b/plotly/graph_objects/isosurface/caps/_z.py index a4fe5cca52..990dab695a 100644 --- a/plotly/graph_objects/isosurface/caps/_z.py +++ b/plotly/graph_objects/isosurface/caps/_z.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/colorbar/_tickfont.py b/plotly/graph_objects/isosurface/colorbar/_tickfont.py index df70e4a385..dc5e788285 100644 --- a/plotly/graph_objects/isosurface/colorbar/_tickfont.py +++ b/plotly/graph_objects/isosurface/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/isosurface/colorbar/_tickformatstop.py b/plotly/graph_objects/isosurface/colorbar/_tickformatstop.py index 2e80aadca1..c9289574b8 100644 --- a/plotly/graph_objects/isosurface/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/isosurface/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/isosurface/colorbar/_title.py b/plotly/graph_objects/isosurface/colorbar/_title.py index c2fd34389c..db2ab4a4b7 100644 --- a/plotly/graph_objects/isosurface/colorbar/_title.py +++ b/plotly/graph_objects/isosurface/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.isosurface.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.isosurface.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/isosurface/colorbar/title/_font.py b/plotly/graph_objects/isosurface/colorbar/title/_font.py index c3d1fc9ac4..d34b4d55a2 100644 --- a/plotly/graph_objects/isosurface/colorbar/title/_font.py +++ b/plotly/graph_objects/isosurface/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/isosurface/hoverlabel/_font.py b/plotly/graph_objects/isosurface/hoverlabel/_font.py index 103ae2087c..e5a263d094 100644 --- a/plotly/graph_objects/isosurface/hoverlabel/_font.py +++ b/plotly/graph_objects/isosurface/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/isosurface/legendgrouptitle/_font.py b/plotly/graph_objects/isosurface/legendgrouptitle/_font.py index abc478d096..02bcf3ec04 100644 --- a/plotly/graph_objects/isosurface/legendgrouptitle/_font.py +++ b/plotly/graph_objects/isosurface/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/isosurface/slices/_x.py b/plotly/graph_objects/isosurface/slices/_x.py index a29464487d..b189237def 100644 --- a/plotly/graph_objects/isosurface/slices/_x.py +++ b/plotly/graph_objects/isosurface/slices/_x.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/slices/_y.py b/plotly/graph_objects/isosurface/slices/_y.py index 1a1cb5da7c..981e1063b0 100644 --- a/plotly/graph_objects/isosurface/slices/_y.py +++ b/plotly/graph_objects/isosurface/slices/_y.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/isosurface/slices/_z.py b/plotly/graph_objects/isosurface/slices/_z.py index a16267a8ec..c8ec74f416 100644 --- a/plotly/graph_objects/isosurface/slices/_z.py +++ b/plotly/graph_objects/isosurface/slices/_z.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/_activeselection.py b/plotly/graph_objects/layout/_activeselection.py index ffb4cda125..a855258585 100644 --- a/plotly/graph_objects/layout/_activeselection.py +++ b/plotly/graph_objects/layout/_activeselection.py @@ -16,11 +16,12 @@ def fillcolor(self): Sets the color filling the active selection' 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ def opacity(self): Sets the opacity of the active selection. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/_activeshape.py b/plotly/graph_objects/layout/_activeshape.py index a27f1e8d5f..72b072d64b 100644 --- a/plotly/graph_objects/layout/_activeshape.py +++ b/plotly/graph_objects/layout/_activeshape.py @@ -16,11 +16,12 @@ def fillcolor(self): Sets the color filling the active shape' interior. The 'fillcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ def opacity(self): Sets the opacity of the active shape. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/_annotation.py b/plotly/graph_objects/layout/_annotation.py index 081cc6cf8a..5bb0bfc72d 100644 --- a/plotly/graph_objects/layout/_annotation.py +++ b/plotly/graph_objects/layout/_annotation.py @@ -63,8 +63,10 @@ def align(self): 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'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -82,11 +84,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -104,7 +107,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 8] Returns @@ -124,7 +128,8 @@ def arrowside(self): The 'arrowside' property is a flaglist and may be specified as a string containing: - - Any combination of ['end', 'start'] joined with '+' characters + + - Any combination of ['end', 'start'] joined with '+' characters (e.g. 'end+start') OR exactly one of ['none'] (e.g. 'none') @@ -146,7 +151,8 @@ def arrowsize(self): 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] + + - An int or float in the interval [0.3, inf] Returns ------- @@ -164,7 +170,8 @@ 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] + + - An int or float in the interval [0.1, inf] Returns ------- @@ -223,10 +230,14 @@ def axref(self): offset for an annotated point. 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]+)?( domain)?$'] + + - One of the following enumeration values: + + ['pixel'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -285,10 +296,14 @@ def ayref(self): offset for an annotated point. 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]+)?( domain)?$'] + + - One of the following enumeration values: + + ['pixel'] + + - A string that matches one of the following regular expressions: + + ['^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -306,11 +321,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -328,11 +344,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -351,7 +368,8 @@ def borderpad(self): border. The 'borderpad' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -370,7 +388,8 @@ def borderwidth(self): `text`. The 'borderwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -422,8 +441,10 @@ def clicktoshow(self): `xclick` and `yclick`. The 'clicktoshow' property is an enumeration that may be specified as: - - One of the following enumeration values: - [False, 'onoff', 'onout'] + + - One of the following enumeration values: + + [False, 'onoff', 'onout'] Returns ------- @@ -442,9 +463,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.annotation.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.annotation.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -463,7 +484,8 @@ def height(self): 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] + + - An int or float in the interval [1, inf] Returns ------- @@ -480,9 +502,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.annotation.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.layout.annotation.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -501,8 +523,10 @@ def hovertext(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -526,8 +550,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -545,7 +571,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -587,7 +614,8 @@ def standoff(self): / `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] + + - An int or float in the interval [0, inf] Returns ------- @@ -605,7 +633,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 8] Returns @@ -626,7 +655,8 @@ def startarrowsize(self): 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] + + - An int or float in the interval [0.3, inf] Returns ------- @@ -648,7 +678,8 @@ def startstandoff(self): `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] + + - An int or float in the interval [0, inf] Returns ------- @@ -673,8 +704,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -696,8 +729,10 @@ def text(self): and `` 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -738,8 +773,10 @@ def valign(self): text height. The 'valign' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -777,7 +814,8 @@ def width(self): 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] + + - An int or float in the interval [1, inf] Returns ------- @@ -826,8 +864,10 @@ def xanchor(self): 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'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -873,10 +913,14 @@ def xref(self): left and the right of the domain of the second x axis. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -896,7 +940,7 @@ def xshift(self): The 'xshift' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -945,8 +989,10 @@ def yanchor(self): 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'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- @@ -992,10 +1038,14 @@ def yref(self): bottom and the top of the domain of the second y axis. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -1015,7 +1065,7 @@ def yshift(self): The 'yshift' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/_coloraxis.py b/plotly/graph_objects/layout/_coloraxis.py index 609a134b7d..641b888254 100644 --- a/plotly/graph_objects/layout/_coloraxis.py +++ b/plotly/graph_objects/layout/_coloraxis.py @@ -73,7 +73,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -95,7 +95,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -116,7 +116,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -133,9 +133,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.coloraxis.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.layout.coloraxis.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -163,30 +163,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- diff --git a/plotly/graph_objects/layout/_colorscale.py b/plotly/graph_objects/layout/_colorscale.py index 1590094243..4f38e8dda1 100644 --- a/plotly/graph_objects/layout/_colorscale.py +++ b/plotly/graph_objects/layout/_colorscale.py @@ -18,30 +18,31 @@ def diverging(self): The 'diverging' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -62,30 +63,31 @@ def sequential(self): The 'sequential' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -106,30 +108,31 @@ def sequentialminus(self): The 'sequentialminus' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- diff --git a/plotly/graph_objects/layout/_font.py b/plotly/graph_objects/layout/_font.py index 6185103ab0..0fdf788637 100644 --- a/plotly/graph_objects/layout/_font.py +++ b/plotly/graph_objects/layout/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/_geo.py b/plotly/graph_objects/layout/_geo.py index cc9088507f..cd4db694e6 100644 --- a/plotly/graph_objects/layout/_geo.py +++ b/plotly/graph_objects/layout/_geo.py @@ -49,11 +49,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -70,9 +71,9 @@ def center(self): """ The 'center' property is an instance of Center that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.geo.Center` - - A dict of string/value properties that will be passed - to the Center constructor + + - An instance of :class:`plotly.graph_objects.layout.geo.Center` + - A dict of string/value properties that will be passed to the Center constructor Returns ------- @@ -90,11 +91,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -112,7 +114,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -130,11 +133,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -152,7 +156,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -169,9 +174,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.geo.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.geo.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -201,8 +206,10 @@ def fitbounds(self): computations, Defaults to False. The 'fitbounds' property is an enumeration that may be specified as: - - One of the following enumeration values: - [False, 'locations', 'geojson'] + + - One of the following enumeration values: + + [False, 'locations', 'geojson'] Returns ------- @@ -220,11 +227,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -242,7 +250,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -260,11 +269,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -282,11 +292,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -303,9 +314,9 @@ def lataxis(self): """ The 'lataxis' property is an instance of Lataxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.geo.Lataxis` - - A dict of string/value properties that will be passed - to the Lataxis constructor + + - An instance of :class:`plotly.graph_objects.layout.geo.Lataxis` + - A dict of string/value properties that will be passed to the Lataxis constructor Returns ------- @@ -322,9 +333,9 @@ def lonaxis(self): """ The 'lonaxis' property is an instance of Lonaxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.geo.Lonaxis` - - A dict of string/value properties that will be passed - to the Lonaxis constructor + + - An instance of :class:`plotly.graph_objects.layout.geo.Lonaxis` + - A dict of string/value properties that will be passed to the Lonaxis constructor Returns ------- @@ -342,11 +353,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -363,9 +375,9 @@ def projection(self): """ The 'projection' property is an instance of Projection that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.geo.Projection` - - A dict of string/value properties that will be passed - to the Projection constructor + + - An instance of :class:`plotly.graph_objects.layout.geo.Projection` + - A dict of string/value properties that will be passed to the Projection constructor Returns ------- @@ -385,8 +397,10 @@ def resolution(self): 1:110,000,000. The 'resolution' property is an enumeration that may be specified as: - - One of the following enumeration values: - [110, 50] + + - One of the following enumeration values: + + [110, 50] Returns ------- @@ -404,11 +418,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -426,7 +441,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -444,9 +460,11 @@ 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: - ['africa', 'asia', 'europe', 'north america', 'south - america', 'usa', 'world'] + + - One of the following enumeration values: + + ['africa', 'asia', 'europe', 'north america', 'south america', + 'usa', 'world'] Returns ------- @@ -609,11 +627,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -631,7 +650,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/_grid.py b/plotly/graph_objects/layout/_grid.py index c95e7eb048..f027465ab7 100644 --- a/plotly/graph_objects/layout/_grid.py +++ b/plotly/graph_objects/layout/_grid.py @@ -34,7 +34,8 @@ def columns(self): subplots. The 'columns' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -52,9 +53,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.grid.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.grid.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -77,8 +78,10 @@ def pattern(self): iterating rows according to `roworder`. The 'pattern' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['independent', 'coupled'] + + - One of the following enumeration values: + + ['independent', 'coupled'] Returns ------- @@ -97,8 +100,10 @@ def roworder(self): 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'] + + - One of the following enumeration values: + + ['top to bottom', 'bottom to top'] Returns ------- @@ -119,7 +124,8 @@ def rows(self): 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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -147,11 +153,15 @@ def subplots(self): * a 2D list where: - The 'subplots\[i\]\[j\]' property is an enumeration that may be specified as: - - One of the following enumeration values: + 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]+)?$'] + + - 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 ------- @@ -174,12 +184,18 @@ def xaxes(self): 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: + + 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]+)?( domain)?$'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -199,7 +215,8 @@ def xgap(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -219,8 +236,10 @@ def xside(self): 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'] + + - One of the following enumeration values: + + ['bottom', 'bottom plot', 'top plot', 'top'] Returns ------- @@ -243,12 +262,18 @@ def yaxes(self): 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: + + 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]+)?( domain)?$'] + + - A string that matches one of the following regular expressions: + + ['^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -268,7 +293,8 @@ def ygap(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -289,8 +315,10 @@ def yside(self): similar. The 'yside' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'left plot', 'right plot', 'right'] + + - One of the following enumeration values: + + ['left', 'left plot', 'right plot', 'right'] Returns ------- diff --git a/plotly/graph_objects/layout/_hoverlabel.py b/plotly/graph_objects/layout/_hoverlabel.py index a8304fcef5..4b0f355817 100644 --- a/plotly/graph_objects/layout/_hoverlabel.py +++ b/plotly/graph_objects/layout/_hoverlabel.py @@ -25,8 +25,10 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] + + - One of the following enumeration values: + + ['left', 'right', 'auto'] Returns ------- @@ -44,11 +46,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -66,11 +69,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -90,9 +94,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -112,9 +116,9 @@ def grouptitlefont(self): The 'grouptitlefont' property is an instance of Grouptitlefont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.hoverlabel.Grouptitlefont` - - A dict of string/value properties that will be passed - to the Grouptitlefont constructor + + - An instance of :class:`plotly.graph_objects.layout.hoverlabel.Grouptitlefont` + - A dict of string/value properties that will be passed to the Grouptitlefont constructor Returns ------- @@ -137,7 +141,8 @@ def namelength(self): `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) + + - An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807] Returns diff --git a/plotly/graph_objects/layout/_image.py b/plotly/graph_objects/layout/_image.py index 2410e08aa3..720f744e03 100644 --- a/plotly/graph_objects/layout/_image.py +++ b/plotly/graph_objects/layout/_image.py @@ -34,8 +34,10 @@ def layer(self): the entire plot area. The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['below', 'above'] + + - One of the following enumeration values: + + ['below', 'above'] Returns ------- @@ -59,8 +61,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -78,7 +82,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -101,7 +106,7 @@ def sizex(self): The 'sizex' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -124,7 +129,7 @@ def sizey(self): The 'sizey' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -142,8 +147,10 @@ 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'] + + - One of the following enumeration values: + + ['fill', 'contain', 'stretch'] Returns ------- @@ -194,8 +201,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -250,8 +259,10 @@ 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'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -279,10 +290,14 @@ def xref(self): left and the right of the domain of the second x axis. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -319,8 +334,10 @@ 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'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -348,10 +365,14 @@ def yref(self): bottom and the top of the domain of the second y axis. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- diff --git a/plotly/graph_objects/layout/_legend.py b/plotly/graph_objects/layout/_legend.py index 08cf773849..8a76377c01 100644 --- a/plotly/graph_objects/layout/_legend.py +++ b/plotly/graph_objects/layout/_legend.py @@ -45,11 +45,12 @@ def bgcolor(self): `layout.paper_bgcolor`. The 'bgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -67,11 +68,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -89,7 +91,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -109,7 +112,8 @@ def entrywidth(self): to "pixels". The 'entrywidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -127,8 +131,10 @@ def entrywidthmode(self): Determines what entrywidth means. The 'entrywidthmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['fraction', 'pixels'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -147,9 +153,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.legend.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.legend.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -171,8 +177,10 @@ def groupclick(self): graph. The 'groupclick' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['toggleitem', 'togglegroup'] + + - One of the following enumeration values: + + ['toggleitem', 'togglegroup'] Returns ------- @@ -192,9 +200,9 @@ def grouptitlefont(self): The 'grouptitlefont' property is an instance of Grouptitlefont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.legend.Grouptitlefont` - - A dict of string/value properties that will be passed - to the Grouptitlefont constructor + + - An instance of :class:`plotly.graph_objects.layout.legend.Grouptitlefont` + - A dict of string/value properties that will be passed to the Grouptitlefont constructor Returns ------- @@ -212,7 +220,8 @@ def indentation(self): Sets the indentation (in px) of the legend entries. The 'indentation' property is a number and may be specified as: - - An int or float in the interval [-15, inf] + + - An int or float in the interval [-15, inf] Returns ------- @@ -233,8 +242,10 @@ def itemclick(self): False disables legend item click interactions. The 'itemclick' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['toggle', 'toggleothers', False] + + - One of the following enumeration values: + + ['toggle', 'toggleothers', False] Returns ------- @@ -256,8 +267,10 @@ def itemdoubleclick(self): interactions. The 'itemdoubleclick' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['toggle', 'toggleothers', False] + + - One of the following enumeration values: + + ['toggle', 'toggleothers', False] Returns ------- @@ -277,8 +290,10 @@ def itemsizing(self): independent of the symbol size on the graph. The 'itemsizing' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'constant'] + + - One of the following enumeration values: + + ['trace', 'constant'] Returns ------- @@ -297,7 +312,8 @@ def itemwidth(self): other than the title.text). The 'itemwidth' property is a number and may be specified as: - - An int or float in the interval [30, inf] + + - An int or float in the interval [30, inf] Returns ------- @@ -322,7 +338,8 @@ def maxheight(self): `"paper"`, where the reference height is the plot height. The 'maxheight' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -340,8 +357,10 @@ 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -358,9 +377,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.legend.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.legend.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -379,7 +398,8 @@ def tracegroupgap(self): groups. The 'tracegroupgap' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -404,7 +424,8 @@ def traceorder(self): The 'traceorder' property is a flaglist and may be specified as a string containing: - - Any combination of ['reversed', 'grouped'] joined with '+' characters + + - Any combination of ['reversed', 'grouped'] joined with '+' characters (e.g. 'reversed+grouped') OR exactly one of ['normal'] (e.g. 'normal') @@ -443,8 +464,10 @@ def valign(self): their associated text. The 'valign' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -487,7 +510,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -510,8 +533,10 @@ def xanchor(self): legends with respect to their center otherwise. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -531,8 +556,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -558,7 +585,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -581,8 +608,10 @@ def yanchor(self): legends with respect to their middle otherwise. The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- @@ -602,8 +631,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/layout/_map.py b/plotly/graph_objects/layout/_map.py index 6e86092257..be27f08489 100644 --- a/plotly/graph_objects/layout/_map.py +++ b/plotly/graph_objects/layout/_map.py @@ -29,7 +29,7 @@ def bearing(self): The 'bearing' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -46,9 +46,9 @@ def bounds(self): """ The 'bounds' property is an instance of Bounds that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.Bounds` - - A dict of string/value properties that will be passed - to the Bounds constructor + + - An instance of :class:`plotly.graph_objects.layout.map.Bounds` + - A dict of string/value properties that will be passed to the Bounds constructor Returns ------- @@ -65,9 +65,9 @@ def center(self): """ The 'center' property is an instance of Center that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.Center` - - A dict of string/value properties that will be passed - to the Center constructor + + - An instance of :class:`plotly.graph_objects.layout.map.Center` + - A dict of string/value properties that will be passed to the Center constructor Returns ------- @@ -84,9 +84,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.map.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -103,8 +103,9 @@ 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_objects.layout.map.Layer - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.map.Layer + - A list or tuple of dicts of string/value properties that will be passed to the Layer constructor Returns @@ -126,9 +127,9 @@ def layerdefaults(self): The 'layerdefaults' property is an instance of Layer that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.Layer` - - A dict of string/value properties that will be passed - to the Layer constructor + + - An instance of :class:`plotly.graph_objects.layout.map.Layer` + - A dict of string/value properties that will be passed to the Layer constructor Returns ------- @@ -148,7 +149,7 @@ def pitch(self): The 'pitch' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -218,7 +219,7 @@ def zoom(self): The 'zoom' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/_mapbox.py b/plotly/graph_objects/layout/_mapbox.py index f4847d4249..ab0ac533eb 100644 --- a/plotly/graph_objects/layout/_mapbox.py +++ b/plotly/graph_objects/layout/_mapbox.py @@ -33,7 +33,8 @@ def accesstoken(self): streets ) and/or a layout layer references the Mapbox server. The 'accesstoken' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -53,7 +54,7 @@ def bearing(self): The 'bearing' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -70,9 +71,9 @@ def bounds(self): """ The 'bounds' property is an instance of Bounds that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.Bounds` - - A dict of string/value properties that will be passed - to the Bounds constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.Bounds` + - A dict of string/value properties that will be passed to the Bounds constructor Returns ------- @@ -89,9 +90,9 @@ def center(self): """ The 'center' property is an instance of Center that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.Center` - - A dict of string/value properties that will be passed - to the Center constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.Center` + - A dict of string/value properties that will be passed to the Center constructor Returns ------- @@ -108,9 +109,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -127,8 +128,9 @@ 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_objects.layout.mapbox.Layer - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.mapbox.Layer + - A list or tuple of dicts of string/value properties that will be passed to the Layer constructor Returns @@ -150,9 +152,9 @@ def layerdefaults(self): The 'layerdefaults' property is an instance of Layer that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.Layer` - - A dict of string/value properties that will be passed - to the Layer constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.Layer` + - A dict of string/value properties that will be passed to the Layer constructor Returns ------- @@ -172,7 +174,7 @@ def pitch(self): The 'pitch' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -246,7 +248,7 @@ def zoom(self): The 'zoom' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/_margin.py b/plotly/graph_objects/layout/_margin.py index 87687da875..9eccbcf46d 100644 --- a/plotly/graph_objects/layout/_margin.py +++ b/plotly/graph_objects/layout/_margin.py @@ -36,7 +36,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -54,7 +55,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -73,7 +75,8 @@ def pad(self): and the axis lines The 'pad' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -91,7 +94,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -109,7 +113,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/_modebar.py b/plotly/graph_objects/layout/_modebar.py index 0ee3e5041d..922f898f7f 100644 --- a/plotly/graph_objects/layout/_modebar.py +++ b/plotly/graph_objects/layout/_modebar.py @@ -27,11 +27,12 @@ def activecolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -55,9 +56,12 @@ def add(self): "drawclosedpath", "drawcircle", "drawrect", "eraseshape". The 'add' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -93,11 +97,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -115,11 +120,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -137,8 +143,10 @@ 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'] + + - One of the following enumeration values: + + ['v', 'h'] Returns ------- @@ -171,9 +179,12 @@ def remove(self): "zoomOutMap", "zoomOutMapbox", "zoomin", "zoomout". The 'remove' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/layout/_newselection.py b/plotly/graph_objects/layout/_newselection.py index 2a7913b221..76e5ad9d39 100644 --- a/plotly/graph_objects/layout/_newselection.py +++ b/plotly/graph_objects/layout/_newselection.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.newselection.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.layout.newselection.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -39,8 +39,10 @@ def mode(self): declaring extra outlines of the selection. The 'mode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['immediate', 'gradual'] + + - One of the following enumeration values: + + ['immediate', 'gradual'] Returns ------- diff --git a/plotly/graph_objects/layout/_newshape.py b/plotly/graph_objects/layout/_newshape.py index 4e91ccd281..723c7a6d9d 100644 --- a/plotly/graph_objects/layout/_newshape.py +++ b/plotly/graph_objects/layout/_newshape.py @@ -37,8 +37,10 @@ def drawdirection(self): "vertical" allows vertical extend. The 'drawdirection' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['ortho', 'horizontal', 'vertical', 'diagonal'] + + - One of the following enumeration values: + + ['ortho', 'horizontal', 'vertical', 'diagonal'] Returns ------- @@ -59,11 +61,12 @@ def fillcolor(self): a new shape could be started over. The 'fillcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -83,8 +86,10 @@ def fillrule(self): US/docs/Web/SVG/Attribute/fill-rule The 'fillrule' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['evenodd', 'nonzero'] + + - One of the following enumeration values: + + ['evenodd', 'nonzero'] Returns ------- @@ -101,9 +106,9 @@ def label(self): """ The 'label' property is an instance of Label that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.newshape.Label` - - A dict of string/value properties that will be passed - to the Label constructor + + - An instance of :class:`plotly.graph_objects.layout.newshape.Label` + - A dict of string/value properties that will be passed to the Label constructor Returns ------- @@ -123,8 +128,10 @@ def layer(self): traces ("above"). The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['below', 'above', 'between'] + + - One of the following enumeration values: + + ['below', 'above', 'between'] Returns ------- @@ -167,8 +174,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -185,9 +194,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.newshape.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.layout.newshape.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -211,7 +220,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -229,7 +238,8 @@ def legendwidth(self): Sets the width (in px or fraction) of the legend for new shape. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -246,9 +256,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.newshape.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.layout.newshape.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -266,8 +276,10 @@ def name(self): Sets new shape name. The name appears as the legend item. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -285,7 +297,8 @@ def opacity(self): Sets the opacity of new shapes. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -323,8 +336,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- diff --git a/plotly/graph_objects/layout/_polar.py b/plotly/graph_objects/layout/_polar.py index de384d706b..2a3eafd16d 100644 --- a/plotly/graph_objects/layout/_polar.py +++ b/plotly/graph_objects/layout/_polar.py @@ -26,9 +26,9 @@ def angularaxis(self): """ The 'angularaxis' property is an instance of AngularAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.AngularAxis` - - A dict of string/value properties that will be passed - to the AngularAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.AngularAxis` + - A dict of string/value properties that will be passed to the AngularAxis constructor Returns ------- @@ -48,7 +48,8 @@ def bargap(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -70,8 +71,10 @@ def barmode(self): bars. The 'barmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['stack', 'overlay'] + + - One of the following enumeration values: + + ['stack', 'overlay'] Returns ------- @@ -89,11 +92,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,9 +114,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -135,8 +139,10 @@ def gridshape(self): 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'] + + - One of the following enumeration values: + + ['circular', 'linear'] Returns ------- @@ -155,7 +161,8 @@ def hole(self): subplot. The 'hole' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -172,9 +179,9 @@ def radialaxis(self): """ The 'radialaxis' property is an instance of RadialAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.RadialAxis` - - A dict of string/value properties that will be passed - to the RadialAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.RadialAxis` + - A dict of string/value properties that will be passed to the RadialAxis constructor Returns ------- diff --git a/plotly/graph_objects/layout/_scene.py b/plotly/graph_objects/layout/_scene.py index d5dffefb14..648c6ec9ee 100644 --- a/plotly/graph_objects/layout/_scene.py +++ b/plotly/graph_objects/layout/_scene.py @@ -29,8 +29,9 @@ 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_objects.layout.scene.Annotation - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.scene.Annotation + - A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor Returns @@ -53,9 +54,9 @@ def annotationdefaults(self): The 'annotationdefaults' property is an instance of Annotation that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.Annotation` - - A dict of string/value properties that will be passed - to the Annotation constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.Annotation` + - A dict of string/value properties that will be passed to the Annotation constructor Returns ------- @@ -80,8 +81,10 @@ def aspectmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'cube', 'data', 'manual'] Returns ------- @@ -100,9 +103,9 @@ def aspectratio(self): The 'aspectratio' property is an instance of Aspectratio that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.Aspectratio` - - A dict of string/value properties that will be passed - to the Aspectratio constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.Aspectratio` + - A dict of string/value properties that will be passed to the Aspectratio constructor Returns ------- @@ -118,11 +121,12 @@ def aspectratio(self, val): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -139,9 +143,9 @@ def camera(self): """ The 'camera' property is an instance of Camera that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.Camera` - - A dict of string/value properties that will be passed - to the Camera constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.Camera` + - A dict of string/value properties that will be passed to the Camera constructor Returns ------- @@ -158,9 +162,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -178,8 +182,10 @@ 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] + + - One of the following enumeration values: + + ['orbit', 'turntable', 'zoom', 'pan', False] Returns ------- @@ -197,8 +203,10 @@ 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] + + - One of the following enumeration values: + + ['closest', False] Returns ------- @@ -233,9 +241,9 @@ def xaxis(self): """ The 'xaxis' property is an instance of XAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.XAxis` - - A dict of string/value properties that will be passed - to the XAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.XAxis` + - A dict of string/value properties that will be passed to the XAxis constructor Returns ------- @@ -252,9 +260,9 @@ def yaxis(self): """ The 'yaxis' property is an instance of YAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.YAxis` - - A dict of string/value properties that will be passed - to the YAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.YAxis` + - A dict of string/value properties that will be passed to the YAxis constructor Returns ------- @@ -271,9 +279,9 @@ def zaxis(self): """ The 'zaxis' property is an instance of ZAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.ZAxis` - - A dict of string/value properties that will be passed - to the ZAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.ZAxis` + - A dict of string/value properties that will be passed to the ZAxis constructor Returns ------- diff --git a/plotly/graph_objects/layout/_selection.py b/plotly/graph_objects/layout/_selection.py index d73e97504e..bb7cbba056 100644 --- a/plotly/graph_objects/layout/_selection.py +++ b/plotly/graph_objects/layout/_selection.py @@ -28,9 +28,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.selection.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.layout.selection.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -54,8 +54,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -73,7 +75,8 @@ def opacity(self): Sets the opacity of the selection. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -92,8 +95,10 @@ def path(self): in data coordinates. Allowed segments are: M, L and Z. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -118,8 +123,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -140,8 +147,10 @@ def type(self): using `path`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['rect', 'path'] + + - One of the following enumeration values: + + ['rect', 'path'] Returns ------- @@ -203,10 +212,14 @@ def xref(self): left and the right of the domain of the second x axis. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -268,10 +281,14 @@ def yref(self): bottom and the top of the domain of the second y axis. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- diff --git a/plotly/graph_objects/layout/_shape.py b/plotly/graph_objects/layout/_shape.py index 7d502e484e..286e6b347b 100644 --- a/plotly/graph_objects/layout/_shape.py +++ b/plotly/graph_objects/layout/_shape.py @@ -70,11 +70,12 @@ def fillcolor(self): closed shapes. The 'fillcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -95,8 +96,10 @@ def fillrule(self): US/docs/Web/SVG/Attribute/fill-rule The 'fillrule' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['evenodd', 'nonzero'] + + - One of the following enumeration values: + + ['evenodd', 'nonzero'] Returns ------- @@ -113,9 +116,9 @@ def label(self): """ The 'label' property is an instance of Label that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.shape.Label` - - A dict of string/value properties that will be passed - to the Label constructor + + - An instance of :class:`plotly.graph_objects.layout.shape.Label` + - A dict of string/value properties that will be passed to the Label constructor Returns ------- @@ -135,8 +138,10 @@ def layer(self): ("above"). The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['below', 'above', 'between'] + + - One of the following enumeration values: + + ['below', 'above', 'between'] Returns ------- @@ -179,8 +184,10 @@ def legendgroup(self): legend items. The 'legendgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -197,9 +204,9 @@ def legendgrouptitle(self): """ The 'legendgrouptitle' property is an instance of Legendgrouptitle that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.shape.Legendgrouptitle` - - A dict of string/value properties that will be passed - to the Legendgrouptitle constructor + + - An instance of :class:`plotly.graph_objects.layout.shape.Legendgrouptitle` + - A dict of string/value properties that will be passed to the Legendgrouptitle constructor Returns ------- @@ -225,7 +232,7 @@ def legendrank(self): The 'legendrank' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -244,7 +251,8 @@ def legendwidth(self): shape. The 'legendwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -261,9 +269,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.shape.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.layout.shape.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -287,8 +295,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -306,7 +316,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -342,8 +353,10 @@ def path(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -386,8 +399,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -413,8 +428,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['circle', 'rect', 'path', 'line'] Returns ------- @@ -434,8 +451,10 @@ def visible(self): legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'legendonly'] + + - One of the following enumeration values: + + [True, False, 'legendonly'] Returns ------- @@ -474,7 +493,8 @@ def x0shift(self): category. The 'x0shift' property is a number and may be specified as: - - An int or float in the interval [-1, 1] + + - An int or float in the interval [-1, 1] Returns ------- @@ -513,7 +533,8 @@ def x1shift(self): category. The 'x1shift' property is a number and may be specified as: - - An int or float in the interval [-1, 1] + + - An int or float in the interval [-1, 1] Returns ------- @@ -562,10 +583,14 @@ def xref(self): right of the domain of the second x axis. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -590,8 +615,10 @@ def xsizemode(self): 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'] + + - One of the following enumeration values: + + ['scaled', 'pixel'] Returns ------- @@ -630,7 +657,8 @@ def y0shift(self): category. The 'y0shift' property is a number and may be specified as: - - An int or float in the interval [-1, 1] + + - An int or float in the interval [-1, 1] Returns ------- @@ -669,7 +697,8 @@ def y1shift(self): category. The 'y1shift' property is a number and may be specified as: - - An int or float in the interval [-1, 1] + + - An int or float in the interval [-1, 1] Returns ------- @@ -718,10 +747,14 @@ def yref(self): bottom and the top of the domain of the second y axis. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['paper'] + + - A string that matches one of the following regular expressions: + + ['^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -746,8 +779,10 @@ def ysizemode(self): 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'] + + - One of the following enumeration values: + + ['scaled', 'pixel'] Returns ------- diff --git a/plotly/graph_objects/layout/_slider.py b/plotly/graph_objects/layout/_slider.py index f752ccd9b5..0ce95681aa 100644 --- a/plotly/graph_objects/layout/_slider.py +++ b/plotly/graph_objects/layout/_slider.py @@ -42,7 +42,8 @@ def active(self): considered active. The 'active' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -60,11 +61,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -82,11 +84,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -104,11 +107,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -126,7 +130,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -143,9 +148,9 @@ def currentvalue(self): """ The 'currentvalue' property is an instance of Currentvalue that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.slider.Currentvalue` - - A dict of string/value properties that will be passed - to the Currentvalue constructor + + - An instance of :class:`plotly.graph_objects.layout.slider.Currentvalue` + - A dict of string/value properties that will be passed to the Currentvalue constructor Returns ------- @@ -164,9 +169,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.slider.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.slider.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -186,7 +191,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -205,8 +211,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -224,7 +232,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -248,8 +257,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -268,9 +279,9 @@ def pad(self): The 'pad' property is an instance of Pad that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.slider.Pad` - - A dict of string/value properties that will be passed - to the Pad constructor + + - An instance of :class:`plotly.graph_objects.layout.slider.Pad` + - A dict of string/value properties that will be passed to the Pad constructor Returns ------- @@ -287,8 +298,9 @@ 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_objects.layout.slider.Step - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.slider.Step + - A list or tuple of dicts of string/value properties that will be passed to the Step constructor Returns @@ -310,9 +322,9 @@ def stepdefaults(self): The 'stepdefaults' property is an instance of Step that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.slider.Step` - - A dict of string/value properties that will be passed - to the Step constructor + + - An instance of :class:`plotly.graph_objects.layout.slider.Step` + - A dict of string/value properties that will be passed to the Step constructor Returns ------- @@ -337,8 +349,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -356,11 +370,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -378,7 +393,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -396,7 +412,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -413,9 +430,9 @@ def transition(self): """ The 'transition' property is an instance of Transition that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.slider.Transition` - - A dict of string/value properties that will be passed - to the Transition constructor + + - An instance of :class:`plotly.graph_objects.layout.slider.Transition` + - A dict of string/value properties that will be passed to the Transition constructor Returns ------- @@ -451,7 +468,8 @@ 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] + + - An int or float in the interval [-2, 3] Returns ------- @@ -471,8 +489,10 @@ def xanchor(self): range selector. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -490,7 +510,8 @@ 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] + + - An int or float in the interval [-2, 3] Returns ------- @@ -510,8 +531,10 @@ def yanchor(self): range selector. The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- diff --git a/plotly/graph_objects/layout/_smith.py b/plotly/graph_objects/layout/_smith.py index 81b45b0669..d7aded07eb 100644 --- a/plotly/graph_objects/layout/_smith.py +++ b/plotly/graph_objects/layout/_smith.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.smith.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.smith.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -56,9 +57,9 @@ def imaginaryaxis(self): """ The 'imaginaryaxis' property is an instance of Imaginaryaxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.smith.Imaginaryaxis` - - A dict of string/value properties that will be passed - to the Imaginaryaxis constructor + + - An instance of :class:`plotly.graph_objects.layout.smith.Imaginaryaxis` + - A dict of string/value properties that will be passed to the Imaginaryaxis constructor Returns ------- @@ -75,9 +76,9 @@ def realaxis(self): """ The 'realaxis' property is an instance of Realaxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.smith.Realaxis` - - A dict of string/value properties that will be passed - to the Realaxis constructor + + - An instance of :class:`plotly.graph_objects.layout.smith.Realaxis` + - A dict of string/value properties that will be passed to the Realaxis constructor Returns ------- diff --git a/plotly/graph_objects/layout/_template.py b/plotly/graph_objects/layout/_template.py index 2e73113152..65de767edb 100644 --- a/plotly/graph_objects/layout/_template.py +++ b/plotly/graph_objects/layout/_template.py @@ -16,9 +16,9 @@ def data(self): """ The 'data' property is an instance of Data that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.template.Data` - - A dict of string/value properties that will be passed - to the Data constructor + + - An instance of :class:`plotly.graph_objects.layout.template.Data` + - A dict of string/value properties that will be passed to the Data constructor Returns ------- @@ -35,9 +35,9 @@ def layout(self): """ The 'layout' property is an instance of Layout that may be specified as: - - An instance of :class:`plotly.graph_objects.Layout` - - A dict of string/value properties that will be passed - to the Layout constructor + + - An instance of :class:`plotly.graph_objects.Layout` + - A dict of string/value properties that will be passed to the Layout constructor Returns ------- diff --git a/plotly/graph_objects/layout/_ternary.py b/plotly/graph_objects/layout/_ternary.py index ba4dbbfd6e..74b10cc6aa 100644 --- a/plotly/graph_objects/layout/_ternary.py +++ b/plotly/graph_objects/layout/_ternary.py @@ -15,9 +15,9 @@ def aaxis(self): """ The 'aaxis' property is an instance of Aaxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.Aaxis` - - A dict of string/value properties that will be passed - to the Aaxis constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.Aaxis` + - A dict of string/value properties that will be passed to the Aaxis constructor Returns ------- @@ -34,9 +34,9 @@ def baxis(self): """ The 'baxis' property is an instance of Baxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.Baxis` - - A dict of string/value properties that will be passed - to the Baxis constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.Baxis` + - A dict of string/value properties that will be passed to the Baxis constructor Returns ------- @@ -54,11 +54,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -75,9 +76,9 @@ def caxis(self): """ The 'caxis' property is an instance of Caxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.Caxis` - - A dict of string/value properties that will be passed - to the Caxis constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.Caxis` + - A dict of string/value properties that will be passed to the Caxis constructor Returns ------- @@ -94,9 +95,9 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.Domain` - - A dict of string/value properties that will be passed - to the Domain constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.Domain` + - A dict of string/value properties that will be passed to the Domain constructor Returns ------- @@ -115,7 +116,8 @@ def sum(self): each axis The 'sum' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/_title.py b/plotly/graph_objects/layout/_title.py index b6e7990cc6..4c2388420d 100644 --- a/plotly/graph_objects/layout/_title.py +++ b/plotly/graph_objects/layout/_title.py @@ -57,9 +57,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -83,9 +83,9 @@ def pad(self): The 'pad' property is an instance of Pad that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.title.Pad` - - A dict of string/value properties that will be passed - to the Pad constructor + + - An instance of :class:`plotly.graph_objects.layout.title.Pad` + - A dict of string/value properties that will be passed to the Pad constructor Returns ------- @@ -102,9 +102,9 @@ def subtitle(self): """ The 'subtitle' property is an instance of Subtitle that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.title.Subtitle` - - A dict of string/value properties that will be passed - to the Subtitle constructor + + - An instance of :class:`plotly.graph_objects.layout.title.Subtitle` + - A dict of string/value properties that will be passed to the Subtitle constructor Returns ------- @@ -122,8 +122,10 @@ def text(self): Sets the plot's title. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -142,7 +144,8 @@ def x(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -165,8 +168,10 @@ def xanchor(self): of `x`. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -186,8 +191,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -208,7 +215,8 @@ def y(self): margin. The 'y' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -231,8 +239,10 @@ def yanchor(self): 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'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- @@ -252,8 +262,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/layout/_transition.py b/plotly/graph_objects/layout/_transition.py index ceacedafd2..068b6389a1 100644 --- a/plotly/graph_objects/layout/_transition.py +++ b/plotly/graph_objects/layout/_transition.py @@ -17,7 +17,8 @@ def duration(self): zero, updates are synchronous. The 'duration' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -35,16 +36,17 @@ 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'] + + - 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 ------- @@ -64,8 +66,10 @@ def ordering(self): change. The 'ordering' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['layout first', 'traces first'] + + - One of the following enumeration values: + + ['layout first', 'traces first'] Returns ------- diff --git a/plotly/graph_objects/layout/_uniformtext.py b/plotly/graph_objects/layout/_uniformtext.py index cd54105677..43962e48cd 100644 --- a/plotly/graph_objects/layout/_uniformtext.py +++ b/plotly/graph_objects/layout/_uniformtext.py @@ -16,7 +16,8 @@ def minsize(self): Sets the minimum text size between traces of the same type. The 'minsize' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -41,8 +42,10 @@ def mode(self): used. The 'mode' property is an enumeration that may be specified as: - - One of the following enumeration values: - [False, 'hide', 'show'] + + - One of the following enumeration values: + + [False, 'hide', 'show'] Returns ------- diff --git a/plotly/graph_objects/layout/_updatemenu.py b/plotly/graph_objects/layout/_updatemenu.py index ca11496261..317465ccef 100644 --- a/plotly/graph_objects/layout/_updatemenu.py +++ b/plotly/graph_objects/layout/_updatemenu.py @@ -36,7 +36,8 @@ def active(self): considered active. The 'active' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807] Returns @@ -55,11 +56,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -77,11 +79,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -99,7 +102,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -116,8 +120,9 @@ 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_objects.layout.updatemenu.Button - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.updatemenu.Button + - A list or tuple of dicts of string/value properties that will be passed to the Button constructor Returns @@ -140,9 +145,9 @@ def buttondefaults(self): The 'buttondefaults' property is an instance of Button that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.updatemenu.Button` - - A dict of string/value properties that will be passed - to the Button constructor + + - An instance of :class:`plotly.graph_objects.layout.updatemenu.Button` + - A dict of string/value properties that will be passed to the Button constructor Returns ------- @@ -163,8 +168,10 @@ def direction(self): 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'] + + - One of the following enumeration values: + + ['left', 'right', 'up', 'down'] Returns ------- @@ -183,9 +190,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.updatemenu.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.updatemenu.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -209,8 +216,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -229,9 +238,9 @@ def pad(self): The 'pad' property is an instance of Pad that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.updatemenu.Pad` - - A dict of string/value properties that will be passed - to the Pad constructor + + - An instance of :class:`plotly.graph_objects.layout.updatemenu.Pad` + - A dict of string/value properties that will be passed to the Pad constructor Returns ------- @@ -274,8 +283,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -295,8 +306,10 @@ def type(self): vertically The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['dropdown', 'buttons'] + + - One of the following enumeration values: + + ['dropdown', 'buttons'] Returns ------- @@ -333,7 +346,8 @@ def x(self): menu. The 'x' property is a number and may be specified as: - - An int or float in the interval [-2, 3] + + - An int or float in the interval [-2, 3] Returns ------- @@ -353,8 +367,10 @@ def xanchor(self): the range selector. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -373,7 +389,8 @@ def y(self): menu. The 'y' property is a number and may be specified as: - - An int or float in the interval [-2, 3] + + - An int or float in the interval [-2, 3] Returns ------- @@ -393,8 +410,10 @@ def yanchor(self): the range selector. The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- diff --git a/plotly/graph_objects/layout/_xaxis.py b/plotly/graph_objects/layout/_xaxis.py index cb8edd55a2..bbe378f024 100644 --- a/plotly/graph_objects/layout/_xaxis.py +++ b/plotly/graph_objects/layout/_xaxis.py @@ -113,11 +113,15 @@ def anchor(self): 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]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['free'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -137,7 +141,8 @@ def automargin(self): The 'automargin' property is a flaglist and may be specified as a string containing: - - Any combination of ['height', 'width', 'left', 'right', 'top', 'bottom'] joined with '+' characters + + - Any combination of ['height', 'width', 'left', 'right', 'top', 'bottom'] joined with '+' characters (e.g. 'height+width') OR exactly one of [True, False] (e.g. 'False') @@ -166,9 +171,11 @@ def autorange(self): and reverses the axis direction. The 'autorange' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed', 'min reversed', 'max reversed', - 'min', 'max'] + + - One of the following enumeration values: + + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] Returns ------- @@ -185,9 +192,9 @@ def autorangeoptions(self): """ The 'autorangeoptions' property is an instance of Autorangeoptions that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Autorangeoptions` - - A dict of string/value properties that will be passed - to the Autorangeoptions constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Autorangeoptions` + - A dict of string/value properties that will be passed to the Autorangeoptions constructor Returns ------- @@ -207,11 +214,13 @@ def autotickangles(self): overlap. The 'autotickangles' property is an info array that may be specified as: + * a list of elements where: - The 'autotickangles[i]' 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). + + The 'autotickangles[i]' 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 ------- @@ -232,8 +241,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -254,11 +265,13 @@ def calendar(self): global `layout.calendar` The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -329,14 +342,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -357,11 +372,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -383,8 +399,10 @@ def constrain(self): containing image traces, "range" otherwise. The 'constrain' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['range', 'domain'] + + - One of the following enumeration values: + + ['range', 'domain'] Returns ------- @@ -407,8 +425,10 @@ def constraintoward(self): axes. The 'constraintoward' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right', 'top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['left', 'center', 'right', 'top', 'middle', 'bottom'] Returns ------- @@ -427,11 +447,12 @@ def dividercolor(self): "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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -451,7 +472,7 @@ def dividerwidth(self): The 'dividerwidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -473,10 +494,12 @@ def domain(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -534,8 +557,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -572,11 +597,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -597,10 +623,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -618,7 +648,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -645,8 +676,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -720,8 +753,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -739,11 +774,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -761,7 +797,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -785,9 +822,11 @@ def matches(self): that matching axes must have the same `type`. The 'matches' property is an enumeration that may be specified as: - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -840,7 +879,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -857,9 +897,9 @@ def minor(self): """ The 'minor' property is an instance of Minor that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Minor` - - A dict of string/value properties that will be passed - to the Minor constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Minor` + - A dict of string/value properties that will be passed to the Minor constructor Returns ------- @@ -882,8 +922,10 @@ def mirror(self): 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'] + + - One of the following enumeration values: + + [True, 'ticks', False, 'all', 'allticks'] Returns ------- @@ -904,7 +946,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -927,11 +970,15 @@ def overlaying(self): 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]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['free'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -951,7 +998,8 @@ def position(self): to "free". The 'position' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -1000,8 +1048,9 @@ def rangebreaks(self): """ The 'rangebreaks' property is a tuple of instances of Rangebreak that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.xaxis.Rangebreak - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.xaxis.Rangebreak + - A list or tuple of dicts of string/value properties that will be passed to the Rangebreak constructor Returns @@ -1024,9 +1073,9 @@ def rangebreakdefaults(self): The 'rangebreakdefaults' property is an instance of Rangebreak that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Rangebreak` - - A dict of string/value properties that will be passed - to the Rangebreak constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Rangebreak` + - A dict of string/value properties that will be passed to the Rangebreak constructor Returns ------- @@ -1048,8 +1097,10 @@ def rangemode(self): linear axes. The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -1066,9 +1117,9 @@ def rangeselector(self): """ The 'rangeselector' property is an instance of Rangeselector that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Rangeselector` - - A dict of string/value properties that will be passed - to the Rangeselector constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Rangeselector` + - A dict of string/value properties that will be passed to the Rangeselector constructor Returns ------- @@ -1085,9 +1136,9 @@ def rangeslider(self): """ The 'rangeslider' property is an instance of Rangeslider that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Rangeslider` - - A dict of string/value properties that will be passed - to the Rangeslider constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Rangeslider` + - A dict of string/value properties that will be passed to the Rangeslider constructor Returns ------- @@ -1126,11 +1177,15 @@ def scaleanchor(self): the constraint). The 'scaleanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - [False] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + [False] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -1153,7 +1208,8 @@ def scaleratio(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1212,8 +1268,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -1309,8 +1367,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -1328,8 +1388,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -1348,8 +1410,10 @@ def side(self): ("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'] + + - One of the following enumeration values: + + ['top', 'bottom', 'left', 'right'] Returns ------- @@ -1367,11 +1431,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1392,10 +1457,14 @@ def spikedash(self): "5px,10px,2px,2px"). The 'spikedash' 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.) + + - 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 ------- @@ -1418,7 +1487,8 @@ def spikemode(self): The 'spikemode' property is a flaglist and may be specified as a string containing: - - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters + + - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters (e.g. 'toaxis+across') Returns @@ -1438,8 +1508,10 @@ def spikesnap(self): closest datapoints. The 'spikesnap' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['data', 'cursor', 'hovered data'] + + - One of the following enumeration values: + + ['data', 'cursor', 'hovered data'] Returns ------- @@ -1458,7 +1530,7 @@ def spikethickness(self): The 'spikethickness' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1523,11 +1595,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1546,9 +1619,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -1575,8 +1648,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1593,8 +1668,9 @@ 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_objects.layout.xaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.xaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1617,9 +1693,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1644,7 +1720,8 @@ def ticklabelindex(self): there. The 'ticklabelindex' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) - A tuple, list, or one-dimensional numpy array of the above Returns @@ -1685,8 +1762,10 @@ def ticklabelmode(self): the middle of the period between ticks. The 'ticklabelmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['instant', 'period'] + + - One of the following enumeration values: + + ['instant', 'period'] Returns ------- @@ -1708,8 +1787,10 @@ def ticklabeloverflow(self): other cases the default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -1735,10 +1816,12 @@ def ticklabelposition(self): added by autorange, so that the scales could match. The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -1758,7 +1841,8 @@ def ticklabelshift(self): positive direction of the axis. The 'ticklabelshift' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -1784,7 +1868,8 @@ def ticklabelstandoff(self): ticks can even end up outside and vice versa. The 'ticklabelstandoff' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -1807,7 +1892,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -1826,7 +1912,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1852,8 +1939,10 @@ def tickmode(self): `overlaying` property. The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array', 'sync'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array', 'sync'] Returns ------- @@ -1871,8 +1960,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1892,8 +1983,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -1915,8 +2008,10 @@ def tickson(self): left/bottom of labels. The 'tickson' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['labels', 'boundaries'] + + - One of the following enumeration values: + + ['labels', 'boundaries'] Returns ------- @@ -1934,8 +2029,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -2028,7 +2125,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -2045,9 +2143,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -2067,9 +2165,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'log', 'date', 'category', 'multicategory'] Returns ------- @@ -2146,11 +2245,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -2173,8 +2273,10 @@ def zerolinelayer(self): property is set on any trace. The 'zerolinelayer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -2193,7 +2295,7 @@ def zerolinewidth(self): The 'zerolinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/_yaxis.py b/plotly/graph_objects/layout/_yaxis.py index 65f63170b5..ab5a5c9df1 100644 --- a/plotly/graph_objects/layout/_yaxis.py +++ b/plotly/graph_objects/layout/_yaxis.py @@ -113,11 +113,15 @@ def anchor(self): 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]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['free'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -137,7 +141,8 @@ def automargin(self): The 'automargin' property is a flaglist and may be specified as a string containing: - - Any combination of ['height', 'width', 'left', 'right', 'top', 'bottom'] joined with '+' characters + + - Any combination of ['height', 'width', 'left', 'right', 'top', 'bottom'] joined with '+' characters (e.g. 'height+width') OR exactly one of [True, False] (e.g. 'False') @@ -166,9 +171,11 @@ def autorange(self): and reverses the axis direction. The 'autorange' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed', 'min reversed', 'max reversed', - 'min', 'max'] + + - One of the following enumeration values: + + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] Returns ------- @@ -185,9 +192,9 @@ def autorangeoptions(self): """ The 'autorangeoptions' property is an instance of Autorangeoptions that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.Autorangeoptions` - - A dict of string/value properties that will be passed - to the Autorangeoptions constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.Autorangeoptions` + - A dict of string/value properties that will be passed to the Autorangeoptions constructor Returns ------- @@ -229,11 +236,13 @@ def autotickangles(self): overlap. The 'autotickangles' property is an info array that may be specified as: + * a list of elements where: - The 'autotickangles[i]' 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). + + The 'autotickangles[i]' 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 ------- @@ -254,8 +263,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -276,11 +287,13 @@ def calendar(self): global `layout.calendar` The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -351,14 +364,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -379,11 +394,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -405,8 +421,10 @@ def constrain(self): containing image traces, "range" otherwise. The 'constrain' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['range', 'domain'] + + - One of the following enumeration values: + + ['range', 'domain'] Returns ------- @@ -429,8 +447,10 @@ def constraintoward(self): axes. The 'constraintoward' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right', 'top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['left', 'center', 'right', 'top', 'middle', 'bottom'] Returns ------- @@ -449,11 +469,12 @@ def dividercolor(self): "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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -473,7 +494,7 @@ def dividerwidth(self): The 'dividerwidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -495,10 +516,12 @@ def domain(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -556,8 +579,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -594,11 +619,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -619,10 +645,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -640,7 +670,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -667,8 +698,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -742,8 +775,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -761,11 +796,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -783,7 +819,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -807,9 +844,11 @@ def matches(self): that matching axes must have the same `type`. The 'matches' property is an enumeration that may be specified as: - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -862,7 +901,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -879,9 +919,9 @@ def minor(self): """ The 'minor' property is an instance of Minor that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.Minor` - - A dict of string/value properties that will be passed - to the Minor constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.Minor` + - A dict of string/value properties that will be passed to the Minor constructor Returns ------- @@ -904,8 +944,10 @@ def mirror(self): 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'] + + - One of the following enumeration values: + + [True, 'ticks', False, 'all', 'allticks'] Returns ------- @@ -926,7 +968,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -949,11 +992,15 @@ def overlaying(self): 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]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + ['free'] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -973,7 +1020,8 @@ def position(self): to "free". The 'position' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -1022,8 +1070,9 @@ def rangebreaks(self): """ The 'rangebreaks' property is a tuple of instances of Rangebreak that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.yaxis.Rangebreak - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.yaxis.Rangebreak + - A list or tuple of dicts of string/value properties that will be passed to the Rangebreak constructor Returns @@ -1046,9 +1095,9 @@ def rangebreakdefaults(self): The 'rangebreakdefaults' property is an instance of Rangebreak that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.Rangebreak` - - A dict of string/value properties that will be passed - to the Rangebreak constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.Rangebreak` + - A dict of string/value properties that will be passed to the Rangebreak constructor Returns ------- @@ -1070,8 +1119,10 @@ def rangemode(self): linear axes. The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -1110,11 +1161,15 @@ def scaleanchor(self): the constraint). The 'scaleanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - [False] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?( domain)?$', - '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + - One of the following enumeration values: + + [False] + + - A string that matches one of the following regular expressions: + + ['^x(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$', + '^y(\\[2-9\\]|\\[1-9\\]\\[0-9\\]+)?( domain)?$'] Returns ------- @@ -1137,7 +1192,8 @@ def scaleratio(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1180,7 +1236,7 @@ def shift(self): The 'shift' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1221,8 +1277,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -1318,8 +1376,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -1337,8 +1397,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -1357,8 +1419,10 @@ def side(self): ("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'] + + - One of the following enumeration values: + + ['top', 'bottom', 'left', 'right'] Returns ------- @@ -1376,11 +1440,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1401,10 +1466,14 @@ def spikedash(self): "5px,10px,2px,2px"). The 'spikedash' 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.) + + - 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 ------- @@ -1427,7 +1496,8 @@ def spikemode(self): The 'spikemode' property is a flaglist and may be specified as a string containing: - - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters + + - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters (e.g. 'toaxis+across') Returns @@ -1447,8 +1517,10 @@ def spikesnap(self): closest datapoints. The 'spikesnap' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['data', 'cursor', 'hovered data'] + + - One of the following enumeration values: + + ['data', 'cursor', 'hovered data'] Returns ------- @@ -1467,7 +1539,7 @@ def spikethickness(self): The 'spikethickness' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1532,11 +1604,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1555,9 +1628,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -1584,8 +1657,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1602,8 +1677,9 @@ 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_objects.layout.yaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.yaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1626,9 +1702,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1653,7 +1729,8 @@ def ticklabelindex(self): there. The 'ticklabelindex' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) - A tuple, list, or one-dimensional numpy array of the above Returns @@ -1694,8 +1771,10 @@ def ticklabelmode(self): the middle of the period between ticks. The 'ticklabelmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['instant', 'period'] + + - One of the following enumeration values: + + ['instant', 'period'] Returns ------- @@ -1717,8 +1796,10 @@ def ticklabeloverflow(self): other cases the default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -1744,10 +1825,12 @@ def ticklabelposition(self): added by autorange, so that the scales could match. The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -1767,7 +1850,8 @@ def ticklabelshift(self): positive direction of the axis. The 'ticklabelshift' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -1793,7 +1877,8 @@ def ticklabelstandoff(self): ticks can even end up outside and vice versa. The 'ticklabelstandoff' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) Returns ------- @@ -1816,7 +1901,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -1835,7 +1921,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1861,8 +1948,10 @@ def tickmode(self): `overlaying` property. The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array', 'sync'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array', 'sync'] Returns ------- @@ -1880,8 +1969,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1901,8 +1992,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -1924,8 +2017,10 @@ def tickson(self): left/bottom of labels. The 'tickson' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['labels', 'boundaries'] + + - One of the following enumeration values: + + ['labels', 'boundaries'] Returns ------- @@ -1943,8 +2038,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -2037,7 +2134,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -2054,9 +2152,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -2076,9 +2174,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'log', 'date', 'category', 'multicategory'] Returns ------- @@ -2155,11 +2254,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -2182,8 +2282,10 @@ def zerolinelayer(self): property is set on any trace. The 'zerolinelayer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -2202,7 +2304,7 @@ def zerolinewidth(self): The 'zerolinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/annotation/_font.py b/plotly/graph_objects/layout/annotation/_font.py index a97d4881d2..bfcd8ae0db 100644 --- a/plotly/graph_objects/layout/annotation/_font.py +++ b/plotly/graph_objects/layout/annotation/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/annotation/_hoverlabel.py b/plotly/graph_objects/layout/annotation/_hoverlabel.py index ef09334248..a070e4b728 100644 --- a/plotly/graph_objects/layout/annotation/_hoverlabel.py +++ b/plotly/graph_objects/layout/annotation/_hoverlabel.py @@ -18,11 +18,12 @@ def bgcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,11 +43,12 @@ def bordercolor(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -66,9 +68,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.annotation.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.annotation.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- diff --git a/plotly/graph_objects/layout/annotation/hoverlabel/_font.py b/plotly/graph_objects/layout/annotation/hoverlabel/_font.py index faf60f8a27..efb86888d1 100644 --- a/plotly/graph_objects/layout/annotation/hoverlabel/_font.py +++ b/plotly/graph_objects/layout/annotation/hoverlabel/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/coloraxis/_colorbar.py b/plotly/graph_objects/layout/coloraxis/_colorbar.py index 0cd923113b..260d30eacb 100644 --- a/plotly/graph_objects/layout/coloraxis/_colorbar.py +++ b/plotly/graph_objects/layout/coloraxis/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.layout.coloraxis.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.coloraxis.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/layout/coloraxis/colorbar/_tickfont.py b/plotly/graph_objects/layout/coloraxis/colorbar/_tickfont.py index 0f29f00a69..224f2564d5 100644 --- a/plotly/graph_objects/layout/coloraxis/colorbar/_tickfont.py +++ b/plotly/graph_objects/layout/coloraxis/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/coloraxis/colorbar/_tickformatstop.py b/plotly/graph_objects/layout/coloraxis/colorbar/_tickformatstop.py index 885b2c8896..94162c2469 100644 --- a/plotly/graph_objects/layout/coloraxis/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/layout/coloraxis/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/coloraxis/colorbar/_title.py b/plotly/graph_objects/layout/coloraxis/colorbar/_title.py index e62bd3240a..9f1b76e5e1 100644 --- a/plotly/graph_objects/layout/coloraxis/colorbar/_title.py +++ b/plotly/graph_objects/layout/coloraxis/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.coloraxis.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/coloraxis/colorbar/title/_font.py b/plotly/graph_objects/layout/coloraxis/colorbar/title/_font.py index 7e3715e57a..1d0fb70602 100644 --- a/plotly/graph_objects/layout/coloraxis/colorbar/title/_font.py +++ b/plotly/graph_objects/layout/coloraxis/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/geo/_center.py b/plotly/graph_objects/layout/geo/_center.py index 83e41ed9dd..88fbbbae9f 100644 --- a/plotly/graph_objects/layout/geo/_center.py +++ b/plotly/graph_objects/layout/geo/_center.py @@ -19,7 +19,7 @@ def lat(self): The 'lat' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -41,7 +41,7 @@ def lon(self): The 'lon' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/geo/_domain.py b/plotly/graph_objects/layout/geo/_domain.py index ea12abacc2..9a12b4d3e9 100644 --- a/plotly/graph_objects/layout/geo/_domain.py +++ b/plotly/graph_objects/layout/geo/_domain.py @@ -20,7 +20,8 @@ def column(self): both. The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -43,7 +44,8 @@ def row(self): both. The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -69,10 +71,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -97,10 +101,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/geo/_lataxis.py b/plotly/graph_objects/layout/geo/_lataxis.py index 469e8f522e..0260f64eaf 100644 --- a/plotly/graph_objects/layout/geo/_lataxis.py +++ b/plotly/graph_objects/layout/geo/_lataxis.py @@ -25,7 +25,7 @@ def dtick(self): The 'dtick' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -43,11 +43,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -68,10 +69,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -89,7 +94,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -154,7 +160,7 @@ def tick0(self): The 'tick0' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/geo/_lonaxis.py b/plotly/graph_objects/layout/geo/_lonaxis.py index a63640f28e..c7a13d1abb 100644 --- a/plotly/graph_objects/layout/geo/_lonaxis.py +++ b/plotly/graph_objects/layout/geo/_lonaxis.py @@ -25,7 +25,7 @@ def dtick(self): The 'dtick' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -43,11 +43,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -68,10 +69,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -89,7 +94,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -154,7 +160,7 @@ def tick0(self): The 'tick0' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/geo/_projection.py b/plotly/graph_objects/layout/geo/_projection.py index 160a31ae10..0c7de5d249 100644 --- a/plotly/graph_objects/layout/geo/_projection.py +++ b/plotly/graph_objects/layout/geo/_projection.py @@ -18,7 +18,8 @@ def distance(self): the sphere’s radius. The 'distance' property is a number and may be specified as: - - An int or float in the interval [1.001, inf] + + - An int or float in the interval [1.001, inf] Returns ------- @@ -63,9 +64,9 @@ def rotation(self): """ The 'rotation' property is an instance of Rotation that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.geo.projection.Rotation` - - A dict of string/value properties that will be passed - to the Rotation constructor + + - An instance of :class:`plotly.graph_objects.layout.geo.projection.Rotation` + - A dict of string/value properties that will be passed to the Rotation constructor Returns ------- @@ -84,7 +85,8 @@ def scale(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -104,7 +106,7 @@ def tilt(self): The 'tilt' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -122,31 +124,31 @@ def type(self): Sets the projection type. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['airy', 'aitoff', 'albers', 'albers usa', 'august', - 'azimuthal equal area', 'azimuthal equidistant', 'baker', - 'bertin1953', 'boggs', 'bonne', 'bottomley', 'bromley', - 'collignon', 'conic conformal', 'conic equal area', 'conic - equidistant', 'craig', 'craster', 'cylindrical equal - area', 'cylindrical stereographic', 'eckert1', 'eckert2', - 'eckert3', 'eckert4', 'eckert5', 'eckert6', 'eisenlohr', - 'equal earth', 'equirectangular', 'fahey', 'foucaut', - 'foucaut sinusoidal', 'ginzburg4', 'ginzburg5', - 'ginzburg6', 'ginzburg8', 'ginzburg9', 'gnomonic', - 'gringorten', 'gringorten quincuncial', 'guyou', 'hammer', - 'hill', 'homolosine', 'hufnagel', 'hyperelliptical', - 'kavrayskiy7', 'lagrange', 'larrivee', 'laskowski', - 'loximuthal', 'mercator', 'miller', 'mollweide', 'mt flat - polar parabolic', 'mt flat polar quartic', 'mt flat polar - sinusoidal', 'natural earth', 'natural earth1', 'natural - earth2', 'nell hammer', 'nicolosi', 'orthographic', - 'patterson', 'peirce quincuncial', 'polyconic', - 'rectangular polyconic', 'robinson', 'satellite', 'sinu - mollweide', 'sinusoidal', 'stereographic', 'times', - 'transverse mercator', 'van der grinten', 'van der - grinten2', 'van der grinten3', 'van der grinten4', - 'wagner4', 'wagner6', 'wiechel', 'winkel tripel', - 'winkel3'] + + - One of the following enumeration values: + + ['airy', 'aitoff', 'albers', 'albers usa', 'august', + 'azimuthal equal area', 'azimuthal equidistant', 'baker', + 'bertin1953', 'boggs', 'bonne', 'bottomley', 'bromley', + 'collignon', 'conic conformal', 'conic equal area', 'conic + equidistant', 'craig', 'craster', 'cylindrical equal area', + 'cylindrical stereographic', 'eckert1', 'eckert2', 'eckert3', + 'eckert4', 'eckert5', 'eckert6', 'eisenlohr', 'equal earth', + 'equirectangular', 'fahey', 'foucaut', 'foucaut sinusoidal', + 'ginzburg4', 'ginzburg5', 'ginzburg6', 'ginzburg8', + 'ginzburg9', 'gnomonic', 'gringorten', 'gringorten + quincuncial', 'guyou', 'hammer', 'hill', 'homolosine', + 'hufnagel', 'hyperelliptical', 'kavrayskiy7', 'lagrange', + 'larrivee', 'laskowski', 'loximuthal', 'mercator', 'miller', + 'mollweide', 'mt flat polar parabolic', 'mt flat polar + quartic', 'mt flat polar sinusoidal', 'natural earth', + 'natural earth1', 'natural earth2', 'nell hammer', 'nicolosi', + 'orthographic', 'patterson', 'peirce quincuncial', + 'polyconic', 'rectangular polyconic', 'robinson', 'satellite', + 'sinu mollweide', 'sinusoidal', 'stereographic', 'times', + 'transverse mercator', 'van der grinten', 'van der grinten2', + 'van der grinten3', 'van der grinten4', 'wagner4', 'wagner6', + 'wiechel', 'winkel tripel', 'winkel3'] Returns ------- diff --git a/plotly/graph_objects/layout/geo/projection/_rotation.py b/plotly/graph_objects/layout/geo/projection/_rotation.py index 027d2c230b..a338c0155a 100644 --- a/plotly/graph_objects/layout/geo/projection/_rotation.py +++ b/plotly/graph_objects/layout/geo/projection/_rotation.py @@ -17,7 +17,7 @@ def lat(self): The 'lat' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -37,7 +37,7 @@ def lon(self): The 'lon' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -57,7 +57,7 @@ def roll(self): The 'roll' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/grid/_domain.py b/plotly/graph_objects/layout/grid/_domain.py index c8a6bffb1e..b18c1cd9df 100644 --- a/plotly/graph_objects/layout/grid/_domain.py +++ b/plotly/graph_objects/layout/grid/_domain.py @@ -22,10 +22,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -49,10 +51,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/hoverlabel/_font.py b/plotly/graph_objects/layout/hoverlabel/_font.py index 87a4a7d04f..5c005ab1cc 100644 --- a/plotly/graph_objects/layout/hoverlabel/_font.py +++ b/plotly/graph_objects/layout/hoverlabel/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/hoverlabel/_grouptitlefont.py b/plotly/graph_objects/layout/hoverlabel/_grouptitlefont.py index d996a7ddc8..9b85c26738 100644 --- a/plotly/graph_objects/layout/hoverlabel/_grouptitlefont.py +++ b/plotly/graph_objects/layout/hoverlabel/_grouptitlefont.py @@ -24,11 +24,12 @@ class Grouptitlefont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/legend/_font.py b/plotly/graph_objects/layout/legend/_font.py index f05b510999..817e8ddc43 100644 --- a/plotly/graph_objects/layout/legend/_font.py +++ b/plotly/graph_objects/layout/legend/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/legend/_grouptitlefont.py b/plotly/graph_objects/layout/legend/_grouptitlefont.py index 9ef3bb2e8a..817d0054a4 100644 --- a/plotly/graph_objects/layout/legend/_grouptitlefont.py +++ b/plotly/graph_objects/layout/legend/_grouptitlefont.py @@ -24,11 +24,12 @@ class Grouptitlefont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/legend/_title.py b/plotly/graph_objects/layout/legend/_title.py index 39a6167253..6989e95346 100644 --- a/plotly/graph_objects/layout/legend/_title.py +++ b/plotly/graph_objects/layout/legend/_title.py @@ -18,9 +18,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.legend.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.legend.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -42,8 +42,10 @@ def side(self): for horizontal alignment legend area in both x and y sides. The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'left', 'top left', 'top center', 'top right'] + + - One of the following enumeration values: + + ['top', 'left', 'top left', 'top center', 'top right'] Returns ------- @@ -61,8 +63,10 @@ def text(self): Sets the title of the legend. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/legend/title/_font.py b/plotly/graph_objects/layout/legend/title/_font.py index 8cb77d20df..46f657aad3 100644 --- a/plotly/graph_objects/layout/legend/title/_font.py +++ b/plotly/graph_objects/layout/legend/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/map/_bounds.py b/plotly/graph_objects/layout/map/_bounds.py index 10f96b9d8d..a567a56e3e 100644 --- a/plotly/graph_objects/layout/map/_bounds.py +++ b/plotly/graph_objects/layout/map/_bounds.py @@ -18,7 +18,7 @@ def east(self): The 'east' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -38,7 +38,7 @@ def north(self): The 'north' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -58,7 +58,7 @@ def south(self): The 'south' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -78,7 +78,7 @@ def west(self): The 'west' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/map/_center.py b/plotly/graph_objects/layout/map/_center.py index b16d2b4881..d1e2740abd 100644 --- a/plotly/graph_objects/layout/map/_center.py +++ b/plotly/graph_objects/layout/map/_center.py @@ -17,7 +17,7 @@ def lat(self): The 'lat' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -36,7 +36,7 @@ def lon(self): The 'lon' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/map/_domain.py b/plotly/graph_objects/layout/map/_domain.py index 83f48400a1..e0f66a26d8 100644 --- a/plotly/graph_objects/layout/map/_domain.py +++ b/plotly/graph_objects/layout/map/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this map subplot . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this map subplot . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/map/_layer.py b/plotly/graph_objects/layout/map/_layer.py index c96f9bb6d9..070ffaa3fa 100644 --- a/plotly/graph_objects/layout/map/_layer.py +++ b/plotly/graph_objects/layout/map/_layer.py @@ -37,8 +37,10 @@ def below(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -55,9 +57,9 @@ def circle(self): """ The 'circle' property is an instance of Circle that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.layer.Circle` - - A dict of string/value properties that will be passed - to the Circle constructor + + - An instance of :class:`plotly.graph_objects.layout.map.layer.Circle` + - A dict of string/value properties that will be passed to the Circle constructor Returns ------- @@ -81,11 +83,12 @@ def color(self): (map.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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -122,9 +125,9 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.layer.Fill` - - A dict of string/value properties that will be passed - to the Fill constructor + + - An instance of :class:`plotly.graph_objects.layout.map.layer.Fill` + - A dict of string/value properties that will be passed to the Fill constructor Returns ------- @@ -141,9 +144,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.layer.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.layout.map.layer.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -162,7 +165,8 @@ def maxzoom(self): 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] + + - An int or float in the interval [0, 24] Returns ------- @@ -181,7 +185,8 @@ def minzoom(self): 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] + + - An int or float in the interval [0, 24] Returns ------- @@ -205,8 +210,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -230,7 +237,8 @@ def opacity(self): icon/text opacity (map.layer.paint.text-opacity) The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -270,8 +278,10 @@ def sourceattribution(self): Sets the attribution for this source. The 'sourceattribution' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -291,8 +301,10 @@ def sourcelayer(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -311,8 +323,10 @@ def sourcetype(self): layer data. The 'sourcetype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['geojson', 'vector', 'raster', 'image'] + + - One of the following enumeration values: + + ['geojson', 'vector', 'raster', 'image'] Returns ------- @@ -329,9 +343,9 @@ def symbol(self): """ The 'symbol' property is an instance of Symbol that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.layer.Symbol` - - A dict of string/value properties that will be passed - to the Symbol constructor + + - An instance of :class:`plotly.graph_objects.layout.map.layer.Symbol` + - A dict of string/value properties that will be passed to the Symbol constructor Returns ------- @@ -356,8 +370,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -382,8 +398,10 @@ def type(self): `*image*`, only the "raster" value is allowed. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['circle', 'line', 'fill', 'symbol', 'raster'] + + - One of the following enumeration values: + + ['circle', 'line', 'fill', 'symbol', 'raster'] Returns ------- diff --git a/plotly/graph_objects/layout/map/layer/_circle.py b/plotly/graph_objects/layout/map/layer/_circle.py index 1928db4adf..8d7e5364f4 100644 --- a/plotly/graph_objects/layout/map/layer/_circle.py +++ b/plotly/graph_objects/layout/map/layer/_circle.py @@ -18,7 +18,7 @@ def radius(self): The 'radius' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/map/layer/_fill.py b/plotly/graph_objects/layout/map/layer/_fill.py index 5325bc812c..5d3ffaa2da 100644 --- a/plotly/graph_objects/layout/map/layer/_fill.py +++ b/plotly/graph_objects/layout/map/layer/_fill.py @@ -17,11 +17,12 @@ def outlinecolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/layout/map/layer/_line.py b/plotly/graph_objects/layout/map/layer/_line.py index 319470b973..627bb562e3 100644 --- a/plotly/graph_objects/layout/map/layer/_line.py +++ b/plotly/graph_objects/layout/map/layer/_line.py @@ -55,7 +55,7 @@ def width(self): The 'width' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/map/layer/_symbol.py b/plotly/graph_objects/layout/map/layer/_symbol.py index e97cb92442..e31a7fa229 100644 --- a/plotly/graph_objects/layout/map/layer/_symbol.py +++ b/plotly/graph_objects/layout/map/layer/_symbol.py @@ -17,8 +17,10 @@ def icon(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -38,7 +40,7 @@ def iconsize(self): The 'iconsize' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -61,8 +63,10 @@ def placement(self): geometry The 'placement' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['point', 'line', 'line-center'] + + - One of the following enumeration values: + + ['point', 'line', 'line-center'] Returns ------- @@ -80,8 +84,10 @@ def text(self): Sets the symbol text (map.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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -102,9 +108,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.map.layer.symbol.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.layout.map.layer.symbol.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -123,10 +129,12 @@ def textposition(self): (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'] + + - 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 ------- diff --git a/plotly/graph_objects/layout/map/layer/symbol/_textfont.py b/plotly/graph_objects/layout/map/layer/symbol/_textfont.py index cf29f82b90..841860cf07 100644 --- a/plotly/graph_objects/layout/map/layer/symbol/_textfont.py +++ b/plotly/graph_objects/layout/map/layer/symbol/_textfont.py @@ -14,11 +14,12 @@ class Textfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -56,7 +58,8 @@ def family(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -75,8 +78,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -94,7 +99,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/mapbox/_bounds.py b/plotly/graph_objects/layout/mapbox/_bounds.py index 10b6543405..cbf6c39468 100644 --- a/plotly/graph_objects/layout/mapbox/_bounds.py +++ b/plotly/graph_objects/layout/mapbox/_bounds.py @@ -18,7 +18,7 @@ def east(self): The 'east' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -38,7 +38,7 @@ def north(self): The 'north' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -58,7 +58,7 @@ def south(self): The 'south' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -78,7 +78,7 @@ def west(self): The 'west' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/_center.py b/plotly/graph_objects/layout/mapbox/_center.py index 1108807fb6..2b753821da 100644 --- a/plotly/graph_objects/layout/mapbox/_center.py +++ b/plotly/graph_objects/layout/mapbox/_center.py @@ -17,7 +17,7 @@ def lat(self): The 'lat' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -36,7 +36,7 @@ def lon(self): The 'lon' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/_domain.py b/plotly/graph_objects/layout/mapbox/_domain.py index d648368fd0..552771cc73 100644 --- a/plotly/graph_objects/layout/mapbox/_domain.py +++ b/plotly/graph_objects/layout/mapbox/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/_layer.py b/plotly/graph_objects/layout/mapbox/_layer.py index 6833c4c3f0..7d44ccd2c2 100644 --- a/plotly/graph_objects/layout/mapbox/_layer.py +++ b/plotly/graph_objects/layout/mapbox/_layer.py @@ -37,8 +37,10 @@ def below(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -55,9 +57,9 @@ def circle(self): """ The 'circle' property is an instance of Circle that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Circle` - - A dict of string/value properties that will be passed - to the Circle constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Circle` + - A dict of string/value properties that will be passed to the Circle constructor Returns ------- @@ -81,11 +83,12 @@ def color(self): (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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -122,9 +125,9 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Fill` - - A dict of string/value properties that will be passed - to the Fill constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Fill` + - A dict of string/value properties that will be passed to the Fill constructor Returns ------- @@ -141,9 +144,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -163,7 +166,8 @@ def maxzoom(self): hidden. The 'maxzoom' property is a number and may be specified as: - - An int or float in the interval [0, 24] + + - An int or float in the interval [0, 24] Returns ------- @@ -182,7 +186,8 @@ def minzoom(self): 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] + + - An int or float in the interval [0, 24] Returns ------- @@ -206,8 +211,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -232,7 +239,8 @@ def opacity(self): (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] + + - An int or float in the interval [0, 1] Returns ------- @@ -272,8 +280,10 @@ def sourceattribution(self): Sets the attribution for this source. The 'sourceattribution' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -293,8 +303,10 @@ def sourcelayer(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -313,8 +325,10 @@ def sourcetype(self): layer data. The 'sourcetype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['geojson', 'vector', 'raster', 'image'] + + - One of the following enumeration values: + + ['geojson', 'vector', 'raster', 'image'] Returns ------- @@ -331,9 +345,9 @@ def symbol(self): """ The 'symbol' property is an instance of Symbol that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Symbol` - - A dict of string/value properties that will be passed - to the Symbol constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.Symbol` + - A dict of string/value properties that will be passed to the Symbol constructor Returns ------- @@ -358,8 +372,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -384,8 +400,10 @@ def type(self): `*image*`, only the "raster" value is allowed. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['circle', 'line', 'fill', 'symbol', 'raster'] + + - One of the following enumeration values: + + ['circle', 'line', 'fill', 'symbol', 'raster'] Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/layer/_circle.py b/plotly/graph_objects/layout/mapbox/layer/_circle.py index 818d24f0e3..2823ded4e8 100644 --- a/plotly/graph_objects/layout/mapbox/layer/_circle.py +++ b/plotly/graph_objects/layout/mapbox/layer/_circle.py @@ -18,7 +18,7 @@ def radius(self): The 'radius' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/layer/_fill.py b/plotly/graph_objects/layout/mapbox/layer/_fill.py index f8d081e498..5cd55504cf 100644 --- a/plotly/graph_objects/layout/mapbox/layer/_fill.py +++ b/plotly/graph_objects/layout/mapbox/layer/_fill.py @@ -17,11 +17,12 @@ def outlinecolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/layer/_line.py b/plotly/graph_objects/layout/mapbox/layer/_line.py index ea0d6f724c..94a9a3997b 100644 --- a/plotly/graph_objects/layout/mapbox/layer/_line.py +++ b/plotly/graph_objects/layout/mapbox/layer/_line.py @@ -55,7 +55,7 @@ def width(self): The 'width' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/mapbox/layer/_symbol.py b/plotly/graph_objects/layout/mapbox/layer/_symbol.py index 98c2a7728c..fddbae7846 100644 --- a/plotly/graph_objects/layout/mapbox/layer/_symbol.py +++ b/plotly/graph_objects/layout/mapbox/layer/_symbol.py @@ -17,8 +17,10 @@ def icon(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -38,7 +40,7 @@ def iconsize(self): The 'iconsize' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -61,8 +63,10 @@ def placement(self): 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'] + + - One of the following enumeration values: + + ['point', 'line', 'line-center'] Returns ------- @@ -80,8 +84,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -102,9 +108,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.symbol.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.layout.mapbox.layer.symbol.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -123,10 +129,12 @@ def textposition(self): (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'] + + - 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 ------- diff --git a/plotly/graph_objects/layout/mapbox/layer/symbol/_textfont.py b/plotly/graph_objects/layout/mapbox/layer/symbol/_textfont.py index 18c656098f..238e708caf 100644 --- a/plotly/graph_objects/layout/mapbox/layer/symbol/_textfont.py +++ b/plotly/graph_objects/layout/mapbox/layer/symbol/_textfont.py @@ -14,11 +14,12 @@ class Textfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -56,7 +58,8 @@ def family(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -75,8 +78,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -94,7 +99,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/newselection/_line.py b/plotly/graph_objects/layout/newselection/_line.py index 486e4ee446..80eff9510f 100644 --- a/plotly/graph_objects/layout/newselection/_line.py +++ b/plotly/graph_objects/layout/newselection/_line.py @@ -17,11 +17,12 @@ def color(self): to increase contrast with background color. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,10 +43,14 @@ def dash(self): "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.) + + - 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 ------- @@ -63,7 +68,8 @@ 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 [1, inf] + + - An int or float in the interval [1, inf] Returns ------- diff --git a/plotly/graph_objects/layout/newshape/_label.py b/plotly/graph_objects/layout/newshape/_label.py index f49ba675ea..8245e514b9 100644 --- a/plotly/graph_objects/layout/newshape/_label.py +++ b/plotly/graph_objects/layout/newshape/_label.py @@ -26,9 +26,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.newshape.label.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.newshape.label.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -47,7 +47,8 @@ def padding(self): shape. The 'padding' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -66,8 +67,10 @@ def text(self): for legend item if `name` is not provided. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -113,10 +116,12 @@ def textposition(self): circles, and paths; "middle" for lines. 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', 'start', 'middle', 'end'] + + - One of the following enumeration values: + + ['top left', 'top center', 'top right', 'middle left', 'middle + center', 'middle right', 'bottom left', 'bottom center', + 'bottom right', 'start', 'middle', 'end'] Returns ------- @@ -153,8 +158,10 @@ def texttemplate(self): `ycenter`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -177,8 +184,10 @@ def xanchor(self): the new shape. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -200,8 +209,10 @@ def yanchor(self): label text lines up with the top-most edge of the new shape. The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- diff --git a/plotly/graph_objects/layout/newshape/_legendgrouptitle.py b/plotly/graph_objects/layout/newshape/_legendgrouptitle.py index 6b6c3e5d23..439d152828 100644 --- a/plotly/graph_objects/layout/newshape/_legendgrouptitle.py +++ b/plotly/graph_objects/layout/newshape/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.newshape.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.newshape.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/newshape/_line.py b/plotly/graph_objects/layout/newshape/_line.py index 95f91b2729..dee7e7d491 100644 --- a/plotly/graph_objects/layout/newshape/_line.py +++ b/plotly/graph_objects/layout/newshape/_line.py @@ -17,11 +17,12 @@ def color(self): to increase contrast with background color. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,10 +43,14 @@ def dash(self): "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.) + + - 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 ------- @@ -63,7 +68,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/newshape/label/_font.py b/plotly/graph_objects/layout/newshape/label/_font.py index 5de89293e4..dcee8735a4 100644 --- a/plotly/graph_objects/layout/newshape/label/_font.py +++ b/plotly/graph_objects/layout/newshape/label/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/newshape/legendgrouptitle/_font.py b/plotly/graph_objects/layout/newshape/legendgrouptitle/_font.py index 2cf1c6fd8d..82548657d9 100644 --- a/plotly/graph_objects/layout/newshape/legendgrouptitle/_font.py +++ b/plotly/graph_objects/layout/newshape/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/polar/_angularaxis.py b/plotly/graph_objects/layout/polar/_angularaxis.py index f14a9912d2..11af275a47 100644 --- a/plotly/graph_objects/layout/polar/_angularaxis.py +++ b/plotly/graph_objects/layout/polar/_angularaxis.py @@ -69,8 +69,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -141,14 +143,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -169,11 +173,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -191,8 +196,10 @@ 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'] + + - One of the following enumeration values: + + ['counterclockwise', 'clockwise'] Returns ------- @@ -250,8 +257,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -269,11 +278,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -294,10 +304,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -315,7 +329,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -342,8 +357,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -391,8 +408,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -410,11 +429,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -432,7 +452,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -451,7 +472,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -472,7 +494,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -492,7 +515,8 @@ def period(self): `angularaxis.type` is "category". The 'period' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -556,8 +580,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -633,8 +659,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -652,8 +680,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -672,8 +702,10 @@ def thetaunit(self): 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'] + + - One of the following enumeration values: + + ['radians', 'degrees'] Returns ------- @@ -738,11 +770,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -761,9 +794,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.angularaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.angularaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -790,8 +823,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -808,8 +843,9 @@ 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_objects.layout.polar.angularaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.polar.angularaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -831,9 +867,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.angularaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.angularaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -856,7 +892,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -875,7 +912,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -899,8 +937,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -918,8 +958,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -939,8 +981,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -958,8 +1002,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1052,7 +1098,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1073,8 +1120,10 @@ def type(self): polar axis. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['-', 'linear', 'category'] + + - One of the following enumeration values: + + ['-', 'linear', 'category'] Returns ------- diff --git a/plotly/graph_objects/layout/polar/_domain.py b/plotly/graph_objects/layout/polar/_domain.py index 9b55f2d86c..f3f257f83f 100644 --- a/plotly/graph_objects/layout/polar/_domain.py +++ b/plotly/graph_objects/layout/polar/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/polar/_radialaxis.py b/plotly/graph_objects/layout/polar/_radialaxis.py index 779cae625c..3c77850773 100644 --- a/plotly/graph_objects/layout/polar/_radialaxis.py +++ b/plotly/graph_objects/layout/polar/_radialaxis.py @@ -106,9 +106,11 @@ def autorange(self): and reverses the axis direction. The 'autorange' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed', 'min reversed', 'max reversed', - 'min', 'max'] + + - One of the following enumeration values: + + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] Returns ------- @@ -125,9 +127,9 @@ def autorangeoptions(self): """ The 'autorangeoptions' property is an instance of Autorangeoptions that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Autorangeoptions` - - A dict of string/value properties that will be passed - to the Autorangeoptions constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Autorangeoptions` + - A dict of string/value properties that will be passed to the Autorangeoptions constructor Returns ------- @@ -147,11 +149,13 @@ def autotickangles(self): overlap. The 'autotickangles' property is an info array that may be specified as: + * a list of elements where: - The 'autotickangles[i]' 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). + + The 'autotickangles[i]' 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 ------- @@ -172,8 +176,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -194,11 +200,13 @@ def calendar(self): global `layout.calendar` The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -269,14 +277,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -297,11 +307,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -359,8 +370,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -378,11 +391,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -403,10 +417,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -424,7 +442,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -451,8 +470,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -500,8 +521,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -519,11 +542,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -541,7 +565,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -594,7 +619,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -615,7 +641,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -670,8 +697,10 @@ def rangemode(self): cartesian axes). The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['tozero', 'nonnegative', 'normal'] + + - One of the following enumeration values: + + ['tozero', 'nonnegative', 'normal'] Returns ------- @@ -710,8 +739,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -787,8 +818,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -806,8 +839,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -826,8 +861,10 @@ def side(self): labels appear. The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['clockwise', 'counterclockwise'] + + - One of the following enumeration values: + + ['clockwise', 'counterclockwise'] Returns ------- @@ -892,11 +929,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -915,9 +953,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -944,8 +982,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -962,8 +1002,9 @@ 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_objects.layout.polar.radialaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.polar.radialaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -985,9 +1026,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1010,7 +1051,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -1029,7 +1071,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1053,8 +1096,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -1072,8 +1117,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1093,8 +1140,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -1112,8 +1161,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1206,7 +1257,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1223,9 +1275,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1245,8 +1297,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'log', 'date', 'category'] Returns ------- diff --git a/plotly/graph_objects/layout/polar/angularaxis/_tickfont.py b/plotly/graph_objects/layout/polar/angularaxis/_tickfont.py index 9efb34008b..4b8bc28be9 100644 --- a/plotly/graph_objects/layout/polar/angularaxis/_tickfont.py +++ b/plotly/graph_objects/layout/polar/angularaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/polar/angularaxis/_tickformatstop.py b/plotly/graph_objects/layout/polar/angularaxis/_tickformatstop.py index 3af13ad31d..c3fc8f4ba7 100644 --- a/plotly/graph_objects/layout/polar/angularaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/polar/angularaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/polar/radialaxis/_tickfont.py b/plotly/graph_objects/layout/polar/radialaxis/_tickfont.py index c47da5f2c4..0a9d3d3989 100644 --- a/plotly/graph_objects/layout/polar/radialaxis/_tickfont.py +++ b/plotly/graph_objects/layout/polar/radialaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/polar/radialaxis/_tickformatstop.py b/plotly/graph_objects/layout/polar/radialaxis/_tickformatstop.py index b302df1edc..c58993d701 100644 --- a/plotly/graph_objects/layout/polar/radialaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/polar/radialaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/polar/radialaxis/_title.py b/plotly/graph_objects/layout/polar/radialaxis/_title.py index 50fc2ca9e0..e581a744da 100644 --- a/plotly/graph_objects/layout/polar/radialaxis/_title.py +++ b/plotly/graph_objects/layout/polar/radialaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.polar.radialaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/polar/radialaxis/title/_font.py b/plotly/graph_objects/layout/polar/radialaxis/title/_font.py index beb1ca8c74..609810f479 100644 --- a/plotly/graph_objects/layout/polar/radialaxis/title/_font.py +++ b/plotly/graph_objects/layout/polar/radialaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/_annotation.py b/plotly/graph_objects/layout/scene/_annotation.py index 417ffa6b8e..d54830e98e 100644 --- a/plotly/graph_objects/layout/scene/_annotation.py +++ b/plotly/graph_objects/layout/scene/_annotation.py @@ -57,8 +57,10 @@ def align(self): 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'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -76,11 +78,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -98,7 +101,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 8] Returns @@ -118,7 +122,8 @@ def arrowside(self): The 'arrowside' property is a flaglist and may be specified as a string containing: - - Any combination of ['end', 'start'] joined with '+' characters + + - Any combination of ['end', 'start'] joined with '+' characters (e.g. 'end+start') OR exactly one of ['none'] (e.g. 'none') @@ -140,7 +145,8 @@ def arrowsize(self): 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] + + - An int or float in the interval [0.3, inf] Returns ------- @@ -158,7 +164,8 @@ 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] + + - An int or float in the interval [0.1, inf] Returns ------- @@ -178,7 +185,7 @@ def ax(self): The 'ax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -198,7 +205,7 @@ def ay(self): The 'ay' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -216,11 +223,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -238,11 +246,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -261,7 +270,8 @@ def borderpad(self): border. The 'borderpad' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -280,7 +290,8 @@ def borderwidth(self): `text`. The 'borderwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -322,9 +333,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.annotation.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.annotation.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -343,7 +354,8 @@ def height(self): 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] + + - An int or float in the interval [1, inf] Returns ------- @@ -360,9 +372,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.annotation.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.annotation.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -381,8 +393,10 @@ def hovertext(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -406,8 +420,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -425,7 +441,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -467,7 +484,8 @@ def standoff(self): / `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] + + - An int or float in the interval [0, inf] Returns ------- @@ -485,7 +503,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 8] Returns @@ -506,7 +525,8 @@ def startarrowsize(self): 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] + + - An int or float in the interval [0.3, inf] Returns ------- @@ -528,7 +548,8 @@ def startstandoff(self): `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] + + - An int or float in the interval [0, inf] Returns ------- @@ -553,8 +574,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -576,8 +599,10 @@ def text(self): and `` 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -618,8 +643,10 @@ def valign(self): text height. The 'valign' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -657,7 +684,8 @@ def width(self): 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] + + - An int or float in the interval [1, inf] Returns ------- @@ -700,8 +728,10 @@ def xanchor(self): 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'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -721,7 +751,7 @@ def xshift(self): The 'xshift' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -764,8 +794,10 @@ def yanchor(self): 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'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- @@ -785,7 +817,7 @@ def yshift(self): The 'yshift' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/_aspectratio.py b/plotly/graph_objects/layout/scene/_aspectratio.py index 933cceca6a..d5f8eb47d4 100644 --- a/plotly/graph_objects/layout/scene/_aspectratio.py +++ b/plotly/graph_objects/layout/scene/_aspectratio.py @@ -14,7 +14,8 @@ class Aspectratio(_BaseLayoutHierarchyType): def x(self): """ The 'x' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -30,7 +31,8 @@ def x(self, val): def y(self): """ The 'y' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -46,7 +48,8 @@ def y(self, val): def z(self): """ The 'z' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/scene/_camera.py b/plotly/graph_objects/layout/scene/_camera.py index c9bb4b3764..e6e4e2ff7b 100644 --- a/plotly/graph_objects/layout/scene/_camera.py +++ b/plotly/graph_objects/layout/scene/_camera.py @@ -19,9 +19,9 @@ def center(self): The 'center' property is an instance of Center that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.camera.Center` - - A dict of string/value properties that will be passed - to the Center constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.camera.Center` + - A dict of string/value properties that will be passed to the Center constructor Returns ------- @@ -42,9 +42,9 @@ def eye(self): The 'eye' property is an instance of Eye that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.camera.Eye` - - A dict of string/value properties that will be passed - to the Eye constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.camera.Eye` + - A dict of string/value properties that will be passed to the Eye constructor Returns ------- @@ -61,9 +61,9 @@ def projection(self): """ The 'projection' property is an instance of Projection that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.camera.Projection` - - A dict of string/value properties that will be passed - to the Projection constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.camera.Projection` + - A dict of string/value properties that will be passed to the Projection constructor Returns ------- @@ -85,9 +85,9 @@ def up(self): The 'up' property is an instance of Up that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.camera.Up` - - A dict of string/value properties that will be passed - to the Up constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.camera.Up` + - A dict of string/value properties that will be passed to the Up constructor Returns ------- diff --git a/plotly/graph_objects/layout/scene/_domain.py b/plotly/graph_objects/layout/scene/_domain.py index 6ec3ac30f8..ff34fd7818 100644 --- a/plotly/graph_objects/layout/scene/_domain.py +++ b/plotly/graph_objects/layout/scene/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/scene/_xaxis.py b/plotly/graph_objects/layout/scene/_xaxis.py index 11ffc974ac..2e28d30da4 100644 --- a/plotly/graph_objects/layout/scene/_xaxis.py +++ b/plotly/graph_objects/layout/scene/_xaxis.py @@ -86,9 +86,11 @@ def autorange(self): and reverses the axis direction. The 'autorange' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed', 'min reversed', 'max reversed', - 'min', 'max'] + + - One of the following enumeration values: + + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] Returns ------- @@ -105,9 +107,9 @@ def autorangeoptions(self): """ The 'autorangeoptions' property is an instance of Autorangeoptions that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Autorangeoptions` - - A dict of string/value properties that will be passed - to the Autorangeoptions constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Autorangeoptions` + - A dict of string/value properties that will be passed to the Autorangeoptions constructor Returns ------- @@ -128,8 +130,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -147,11 +151,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -172,11 +177,13 @@ def calendar(self): global `layout.calendar` The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -247,14 +254,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -275,11 +284,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -337,8 +347,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -356,11 +368,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -378,7 +391,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -405,8 +419,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -449,11 +465,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -471,7 +488,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -524,7 +542,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -547,8 +566,10 @@ def mirror(self): 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'] + + - One of the following enumeration values: + + [True, 'ticks', False, 'all', 'allticks'] Returns ------- @@ -569,7 +590,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -624,8 +646,10 @@ def rangemode(self): linear axes. The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -700,8 +724,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -796,8 +822,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -815,8 +843,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -834,11 +864,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -875,7 +906,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -940,11 +972,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -963,9 +996,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -992,8 +1025,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1010,8 +1045,9 @@ 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_objects.layout.scene.xaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.scene.xaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1034,9 +1070,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1054,7 +1090,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1078,8 +1115,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -1097,8 +1136,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1118,8 +1159,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -1137,8 +1180,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1231,7 +1276,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1248,9 +1294,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1270,8 +1316,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'log', 'date', 'category'] Returns ------- @@ -1329,11 +1377,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1352,7 +1401,7 @@ def zerolinewidth(self): The 'zerolinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/_yaxis.py b/plotly/graph_objects/layout/scene/_yaxis.py index 9d4522f09d..3312758fc3 100644 --- a/plotly/graph_objects/layout/scene/_yaxis.py +++ b/plotly/graph_objects/layout/scene/_yaxis.py @@ -86,9 +86,11 @@ def autorange(self): and reverses the axis direction. The 'autorange' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed', 'min reversed', 'max reversed', - 'min', 'max'] + + - One of the following enumeration values: + + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] Returns ------- @@ -105,9 +107,9 @@ def autorangeoptions(self): """ The 'autorangeoptions' property is an instance of Autorangeoptions that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Autorangeoptions` - - A dict of string/value properties that will be passed - to the Autorangeoptions constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Autorangeoptions` + - A dict of string/value properties that will be passed to the Autorangeoptions constructor Returns ------- @@ -128,8 +130,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -147,11 +151,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -172,11 +177,13 @@ def calendar(self): global `layout.calendar` The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -247,14 +254,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -275,11 +284,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -337,8 +347,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -356,11 +368,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -378,7 +391,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -405,8 +419,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -449,11 +465,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -471,7 +488,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -524,7 +542,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -547,8 +566,10 @@ def mirror(self): 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'] + + - One of the following enumeration values: + + [True, 'ticks', False, 'all', 'allticks'] Returns ------- @@ -569,7 +590,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -624,8 +646,10 @@ def rangemode(self): linear axes. The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -700,8 +724,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -796,8 +822,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -815,8 +843,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -834,11 +864,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -875,7 +906,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -940,11 +972,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -963,9 +996,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -992,8 +1025,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1010,8 +1045,9 @@ 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_objects.layout.scene.yaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.scene.yaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1034,9 +1070,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1054,7 +1090,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1078,8 +1115,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -1097,8 +1136,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1118,8 +1159,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -1137,8 +1180,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1231,7 +1276,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1248,9 +1294,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1270,8 +1316,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'log', 'date', 'category'] Returns ------- @@ -1329,11 +1377,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1352,7 +1401,7 @@ def zerolinewidth(self): The 'zerolinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/_zaxis.py b/plotly/graph_objects/layout/scene/_zaxis.py index e801b274a9..06abef309f 100644 --- a/plotly/graph_objects/layout/scene/_zaxis.py +++ b/plotly/graph_objects/layout/scene/_zaxis.py @@ -86,9 +86,11 @@ def autorange(self): and reverses the axis direction. The 'autorange' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed', 'min reversed', 'max reversed', - 'min', 'max'] + + - One of the following enumeration values: + + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] Returns ------- @@ -105,9 +107,9 @@ def autorangeoptions(self): """ The 'autorangeoptions' property is an instance of Autorangeoptions that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Autorangeoptions` - - A dict of string/value properties that will be passed - to the Autorangeoptions constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Autorangeoptions` + - A dict of string/value properties that will be passed to the Autorangeoptions constructor Returns ------- @@ -128,8 +130,10 @@ def autotypenumbers(self): detection. Defaults to layout.autotypenumbers. The 'autotypenumbers' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['convert types', 'strict'] + + - One of the following enumeration values: + + ['convert types', 'strict'] Returns ------- @@ -147,11 +151,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -172,11 +177,13 @@ def calendar(self): global `layout.calendar` The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['chinese', 'coptic', 'discworld', 'ethiopian', - 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', - 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', - 'thai', 'ummalqura'] + + - One of the following enumeration values: + + ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian', + 'hebrew', 'islamic', 'jalali', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai', + 'ummalqura'] Returns ------- @@ -247,14 +254,16 @@ def categoryorder(self): of all the values. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array', 'total ascending', 'total descending', 'min - ascending', 'min descending', 'max ascending', 'max - descending', 'sum ascending', 'sum descending', 'mean - ascending', 'mean descending', 'geometric mean ascending', - 'geometric mean descending', 'median ascending', 'median - descending'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] Returns ------- @@ -275,11 +284,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -337,8 +347,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -356,11 +368,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -378,7 +391,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -405,8 +419,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -449,11 +465,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -471,7 +488,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -524,7 +542,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -547,8 +566,10 @@ def mirror(self): 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'] + + - One of the following enumeration values: + + [True, 'ticks', False, 'all', 'allticks'] Returns ------- @@ -569,7 +590,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -624,8 +646,10 @@ def rangemode(self): linear axes. The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] + + - One of the following enumeration values: + + ['normal', 'tozero', 'nonnegative'] Returns ------- @@ -700,8 +724,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -796,8 +822,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -815,8 +843,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -834,11 +864,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -875,7 +906,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -940,11 +972,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -963,9 +996,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -992,8 +1025,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1010,8 +1045,9 @@ 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_objects.layout.scene.zaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.scene.zaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -1034,9 +1070,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -1054,7 +1090,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1078,8 +1115,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -1097,8 +1136,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1118,8 +1159,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -1137,8 +1180,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -1231,7 +1276,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1248,9 +1294,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -1270,8 +1316,10 @@ def type(self): 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'] + + - One of the following enumeration values: + + ['-', 'linear', 'log', 'date', 'category'] Returns ------- @@ -1329,11 +1377,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -1352,7 +1401,7 @@ def zerolinewidth(self): The 'zerolinewidth' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/annotation/_font.py b/plotly/graph_objects/layout/scene/annotation/_font.py index b737fc2cd8..92df8bc861 100644 --- a/plotly/graph_objects/layout/scene/annotation/_font.py +++ b/plotly/graph_objects/layout/scene/annotation/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/annotation/_hoverlabel.py b/plotly/graph_objects/layout/scene/annotation/_hoverlabel.py index 37ea67576f..13f0f99a5f 100644 --- a/plotly/graph_objects/layout/scene/annotation/_hoverlabel.py +++ b/plotly/graph_objects/layout/scene/annotation/_hoverlabel.py @@ -18,11 +18,12 @@ def bgcolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,11 +43,12 @@ def bordercolor(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -66,9 +68,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.annotation.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.annotation.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- diff --git a/plotly/graph_objects/layout/scene/annotation/hoverlabel/_font.py b/plotly/graph_objects/layout/scene/annotation/hoverlabel/_font.py index a6dc60e951..22df0a1926 100644 --- a/plotly/graph_objects/layout/scene/annotation/hoverlabel/_font.py +++ b/plotly/graph_objects/layout/scene/annotation/hoverlabel/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/camera/_center.py b/plotly/graph_objects/layout/scene/camera/_center.py index d9872315c5..4f5d529a8f 100644 --- a/plotly/graph_objects/layout/scene/camera/_center.py +++ b/plotly/graph_objects/layout/scene/camera/_center.py @@ -15,7 +15,7 @@ def x(self): """ The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -32,7 +32,7 @@ def y(self): """ The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -49,7 +49,7 @@ def z(self): """ The 'z' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/camera/_eye.py b/plotly/graph_objects/layout/scene/camera/_eye.py index 34a5db7c48..7590cc710f 100644 --- a/plotly/graph_objects/layout/scene/camera/_eye.py +++ b/plotly/graph_objects/layout/scene/camera/_eye.py @@ -15,7 +15,7 @@ def x(self): """ The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -32,7 +32,7 @@ def y(self): """ The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -49,7 +49,7 @@ def z(self): """ The 'z' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/camera/_projection.py b/plotly/graph_objects/layout/scene/camera/_projection.py index d294281137..67b7ed9a30 100644 --- a/plotly/graph_objects/layout/scene/camera/_projection.py +++ b/plotly/graph_objects/layout/scene/camera/_projection.py @@ -17,8 +17,10 @@ def type(self): "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'] + + - One of the following enumeration values: + + ['perspective', 'orthographic'] Returns ------- diff --git a/plotly/graph_objects/layout/scene/camera/_up.py b/plotly/graph_objects/layout/scene/camera/_up.py index 5af6c477d8..4ed8e5bf53 100644 --- a/plotly/graph_objects/layout/scene/camera/_up.py +++ b/plotly/graph_objects/layout/scene/camera/_up.py @@ -15,7 +15,7 @@ def x(self): """ The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -32,7 +32,7 @@ def y(self): """ The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -49,7 +49,7 @@ def z(self): """ The 'z' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/scene/xaxis/_tickfont.py b/plotly/graph_objects/layout/scene/xaxis/_tickfont.py index db9f8a5b42..0533cf01c8 100644 --- a/plotly/graph_objects/layout/scene/xaxis/_tickfont.py +++ b/plotly/graph_objects/layout/scene/xaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/xaxis/_tickformatstop.py b/plotly/graph_objects/layout/scene/xaxis/_tickformatstop.py index 88713b8f62..76be0aa5d6 100644 --- a/plotly/graph_objects/layout/scene/xaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/scene/xaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/scene/xaxis/_title.py b/plotly/graph_objects/layout/scene/xaxis/_title.py index c67c4644d2..82b3367c09 100644 --- a/plotly/graph_objects/layout/scene/xaxis/_title.py +++ b/plotly/graph_objects/layout/scene/xaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.xaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/scene/xaxis/title/_font.py b/plotly/graph_objects/layout/scene/xaxis/title/_font.py index 6813ffa081..2a09bd2a70 100644 --- a/plotly/graph_objects/layout/scene/xaxis/title/_font.py +++ b/plotly/graph_objects/layout/scene/xaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/yaxis/_tickfont.py b/plotly/graph_objects/layout/scene/yaxis/_tickfont.py index c7c77b709e..e04073ce2c 100644 --- a/plotly/graph_objects/layout/scene/yaxis/_tickfont.py +++ b/plotly/graph_objects/layout/scene/yaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/yaxis/_tickformatstop.py b/plotly/graph_objects/layout/scene/yaxis/_tickformatstop.py index d4235ce468..47fcb9df1b 100644 --- a/plotly/graph_objects/layout/scene/yaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/scene/yaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/scene/yaxis/_title.py b/plotly/graph_objects/layout/scene/yaxis/_title.py index 0686785e8d..2a88d6ea44 100644 --- a/plotly/graph_objects/layout/scene/yaxis/_title.py +++ b/plotly/graph_objects/layout/scene/yaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.yaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/scene/yaxis/title/_font.py b/plotly/graph_objects/layout/scene/yaxis/title/_font.py index acb63042b2..0d586e5b93 100644 --- a/plotly/graph_objects/layout/scene/yaxis/title/_font.py +++ b/plotly/graph_objects/layout/scene/yaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/zaxis/_tickfont.py b/plotly/graph_objects/layout/scene/zaxis/_tickfont.py index a6aabd4e34..63aa091e1b 100644 --- a/plotly/graph_objects/layout/scene/zaxis/_tickfont.py +++ b/plotly/graph_objects/layout/scene/zaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/scene/zaxis/_tickformatstop.py b/plotly/graph_objects/layout/scene/zaxis/_tickformatstop.py index b550ae6720..1aaa90d57f 100644 --- a/plotly/graph_objects/layout/scene/zaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/scene/zaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/scene/zaxis/_title.py b/plotly/graph_objects/layout/scene/zaxis/_title.py index 4e21e2d66f..09d6e24cd3 100644 --- a/plotly/graph_objects/layout/scene/zaxis/_title.py +++ b/plotly/graph_objects/layout/scene/zaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.scene.zaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/scene/zaxis/title/_font.py b/plotly/graph_objects/layout/scene/zaxis/title/_font.py index f1bc95a414..178d8d5283 100644 --- a/plotly/graph_objects/layout/scene/zaxis/title/_font.py +++ b/plotly/graph_objects/layout/scene/zaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/selection/_line.py b/plotly/graph_objects/layout/selection/_line.py index 8101a84499..dec4cbe21b 100644 --- a/plotly/graph_objects/layout/selection/_line.py +++ b/plotly/graph_objects/layout/selection/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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 [1, inf] + + - An int or float in the interval [1, inf] Returns ------- diff --git a/plotly/graph_objects/layout/shape/_label.py b/plotly/graph_objects/layout/shape/_label.py index 6e33e038cd..a045c5a83c 100644 --- a/plotly/graph_objects/layout/shape/_label.py +++ b/plotly/graph_objects/layout/shape/_label.py @@ -26,9 +26,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.shape.label.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.shape.label.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -46,7 +46,8 @@ def padding(self): Sets padding (in px) between edge of label and edge of shape. The 'padding' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -65,8 +66,10 @@ def text(self): item if `name` is not provided. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,10 +115,12 @@ def textposition(self): circles, and paths; "middle" for lines. 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', 'start', 'middle', 'end'] + + - One of the following enumeration values: + + ['top left', 'top center', 'top right', 'middle left', 'middle + center', 'middle right', 'bottom left', 'bottom center', + 'bottom right', 'start', 'middle', 'end'] Returns ------- @@ -152,8 +157,10 @@ def texttemplate(self): `ycenter`. The 'texttemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -176,8 +183,10 @@ def xanchor(self): the shape. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -199,8 +208,10 @@ def yanchor(self): label text lines up with the top-most edge of the shape. The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- diff --git a/plotly/graph_objects/layout/shape/_legendgrouptitle.py b/plotly/graph_objects/layout/shape/_legendgrouptitle.py index ba1c0b87a0..1ab7686ae0 100644 --- a/plotly/graph_objects/layout/shape/_legendgrouptitle.py +++ b/plotly/graph_objects/layout/shape/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.shape.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.shape.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/shape/_line.py b/plotly/graph_objects/layout/shape/_line.py index 2cc33334e1..9c33b4861c 100644 --- a/plotly/graph_objects/layout/shape/_line.py +++ b/plotly/graph_objects/layout/shape/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/shape/label/_font.py b/plotly/graph_objects/layout/shape/label/_font.py index a8222b6b1f..d27b1a238a 100644 --- a/plotly/graph_objects/layout/shape/label/_font.py +++ b/plotly/graph_objects/layout/shape/label/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/shape/legendgrouptitle/_font.py b/plotly/graph_objects/layout/shape/legendgrouptitle/_font.py index afa129818d..7c185a9dd3 100644 --- a/plotly/graph_objects/layout/shape/legendgrouptitle/_font.py +++ b/plotly/graph_objects/layout/shape/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/slider/_currentvalue.py b/plotly/graph_objects/layout/slider/_currentvalue.py index 858672d86d..28360f440f 100644 --- a/plotly/graph_objects/layout/slider/_currentvalue.py +++ b/plotly/graph_objects/layout/slider/_currentvalue.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.slider.currentvalue.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.slider.currentvalue.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,7 +39,7 @@ def offset(self): The 'offset' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -58,8 +58,10 @@ def prefix(self): label. The 'prefix' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -78,8 +80,10 @@ def suffix(self): label. The 'suffix' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -116,8 +120,10 @@ def xanchor(self): the slider. The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- diff --git a/plotly/graph_objects/layout/slider/_font.py b/plotly/graph_objects/layout/slider/_font.py index fd3d0e1d88..48d2da7342 100644 --- a/plotly/graph_objects/layout/slider/_font.py +++ b/plotly/graph_objects/layout/slider/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/slider/_pad.py b/plotly/graph_objects/layout/slider/_pad.py index b3fff087fb..060775aa07 100644 --- a/plotly/graph_objects/layout/slider/_pad.py +++ b/plotly/graph_objects/layout/slider/_pad.py @@ -18,7 +18,7 @@ def b(self): The 'b' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -38,7 +38,7 @@ def l(self): The 'l' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -58,7 +58,7 @@ def r(self): The 'r' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -77,7 +77,7 @@ def t(self): The 't' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/slider/_step.py b/plotly/graph_objects/layout/slider/_step.py index 1bf953dc0f..6d8e1e9f58 100644 --- a/plotly/graph_objects/layout/slider/_step.py +++ b/plotly/graph_objects/layout/slider/_step.py @@ -75,8 +75,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -99,8 +101,10 @@ def method(self): JavaScript. The 'method' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['restyle', 'relayout', 'animate', 'update', 'skip'] + + - One of the following enumeration values: + + ['restyle', 'relayout', 'animate', 'update', 'skip'] Returns ------- @@ -124,8 +128,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -150,8 +156,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -170,8 +178,10 @@ def value(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/slider/_transition.py b/plotly/graph_objects/layout/slider/_transition.py index 34b485c608..69b231024a 100644 --- a/plotly/graph_objects/layout/slider/_transition.py +++ b/plotly/graph_objects/layout/slider/_transition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -34,16 +35,17 @@ 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'] + + - 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 ------- diff --git a/plotly/graph_objects/layout/slider/currentvalue/_font.py b/plotly/graph_objects/layout/slider/currentvalue/_font.py index 8ca5a8fdf5..1fbf3bec10 100644 --- a/plotly/graph_objects/layout/slider/currentvalue/_font.py +++ b/plotly/graph_objects/layout/slider/currentvalue/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/smith/_domain.py b/plotly/graph_objects/layout/smith/_domain.py index 463a9641db..db7d66236a 100644 --- a/plotly/graph_objects/layout/smith/_domain.py +++ b/plotly/graph_objects/layout/smith/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this smith subplot . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this smith subplot . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/smith/_imaginaryaxis.py b/plotly/graph_objects/layout/smith/_imaginaryaxis.py index 7fb998b127..b57d89b9ef 100644 --- a/plotly/graph_objects/layout/smith/_imaginaryaxis.py +++ b/plotly/graph_objects/layout/smith/_imaginaryaxis.py @@ -45,11 +45,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -67,11 +68,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -92,10 +94,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -113,7 +119,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -140,8 +147,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -189,8 +198,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -208,11 +219,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -230,7 +242,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -306,8 +319,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -325,8 +340,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -344,11 +361,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -367,9 +385,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.smith.imaginaryaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.smith.imaginaryaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -396,8 +414,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -415,7 +435,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -433,8 +454,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -454,8 +477,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -473,8 +498,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -529,7 +556,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/smith/_realaxis.py b/plotly/graph_objects/layout/smith/_realaxis.py index 8d68d5a4c2..613b57605c 100644 --- a/plotly/graph_objects/layout/smith/_realaxis.py +++ b/plotly/graph_objects/layout/smith/_realaxis.py @@ -47,11 +47,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -69,11 +70,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -94,10 +96,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -115,7 +121,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -142,8 +149,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -191,8 +200,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -210,11 +221,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -232,7 +244,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -308,8 +321,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -327,8 +342,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -347,8 +364,10 @@ def side(self): labels appear. The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'bottom'] + + - One of the following enumeration values: + + ['top', 'bottom'] Returns ------- @@ -388,11 +407,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -411,9 +431,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.smith.realaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.smith.realaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -440,8 +460,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -459,7 +481,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -477,8 +500,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -498,8 +523,10 @@ def ticks(self): above (below) the axis line. The 'ticks' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'bottom', ''] + + - One of the following enumeration values: + + ['top', 'bottom', ''] Returns ------- @@ -517,8 +544,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -572,7 +601,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/smith/imaginaryaxis/_tickfont.py b/plotly/graph_objects/layout/smith/imaginaryaxis/_tickfont.py index 67a639f9f1..77c25d837e 100644 --- a/plotly/graph_objects/layout/smith/imaginaryaxis/_tickfont.py +++ b/plotly/graph_objects/layout/smith/imaginaryaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/smith/realaxis/_tickfont.py b/plotly/graph_objects/layout/smith/realaxis/_tickfont.py index a784005e7f..54fa845926 100644 --- a/plotly/graph_objects/layout/smith/realaxis/_tickfont.py +++ b/plotly/graph_objects/layout/smith/realaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/template/_data.py b/plotly/graph_objects/layout/template/_data.py index 9235e8d14b..fee80c7b7a 100644 --- a/plotly/graph_objects/layout/template/_data.py +++ b/plotly/graph_objects/layout/template/_data.py @@ -65,8 +65,9 @@ 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_objects.layout.template.data.Barpolar - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Barpolar + - A list or tuple of dicts of string/value properties that will be passed to the Barpolar constructor Returns @@ -84,8 +85,9 @@ 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_objects.layout.template.data.Bar - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Bar + - A list or tuple of dicts of string/value properties that will be passed to the Bar constructor Returns @@ -103,8 +105,9 @@ 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_objects.layout.template.data.Box - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Box + - A list or tuple of dicts of string/value properties that will be passed to the Box constructor Returns @@ -122,8 +125,9 @@ 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_objects.layout.template.data.Candlestick - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Candlestick + - A list or tuple of dicts of string/value properties that will be passed to the Candlestick constructor Returns @@ -141,8 +145,9 @@ 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_objects.layout.template.data.Carpet - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Carpet + - A list or tuple of dicts of string/value properties that will be passed to the Carpet constructor Returns @@ -160,8 +165,9 @@ def choroplethmapbox(self): """ The 'choroplethmapbox' property is a tuple of instances of Choroplethmapbox that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Choroplethmapbox - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Choroplethmapbox + - A list or tuple of dicts of string/value properties that will be passed to the Choroplethmapbox constructor Returns @@ -179,8 +185,9 @@ def choroplethmap(self): """ The 'choroplethmap' property is a tuple of instances of Choroplethmap that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Choroplethmap - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Choroplethmap + - A list or tuple of dicts of string/value properties that will be passed to the Choroplethmap constructor Returns @@ -198,8 +205,9 @@ 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_objects.layout.template.data.Choropleth - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Choropleth + - A list or tuple of dicts of string/value properties that will be passed to the Choropleth constructor Returns @@ -217,8 +225,9 @@ 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_objects.layout.template.data.Cone - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Cone + - A list or tuple of dicts of string/value properties that will be passed to the Cone constructor Returns @@ -236,8 +245,9 @@ 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_objects.layout.template.data.Contourcarpet - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Contourcarpet + - A list or tuple of dicts of string/value properties that will be passed to the Contourcarpet constructor Returns @@ -255,8 +265,9 @@ 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_objects.layout.template.data.Contour - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Contour + - A list or tuple of dicts of string/value properties that will be passed to the Contour constructor Returns @@ -274,8 +285,9 @@ def densitymapbox(self): """ The 'densitymapbox' property is a tuple of instances of Densitymapbox that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Densitymapbox - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Densitymapbox + - A list or tuple of dicts of string/value properties that will be passed to the Densitymapbox constructor Returns @@ -293,8 +305,9 @@ def densitymap(self): """ The 'densitymap' property is a tuple of instances of Densitymap that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Densitymap - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Densitymap + - A list or tuple of dicts of string/value properties that will be passed to the Densitymap constructor Returns @@ -312,8 +325,9 @@ def funnelarea(self): """ The 'funnelarea' property is a tuple of instances of Funnelarea that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Funnelarea - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Funnelarea + - A list or tuple of dicts of string/value properties that will be passed to the Funnelarea constructor Returns @@ -331,8 +345,9 @@ def funnel(self): """ The 'funnel' property is a tuple of instances of Funnel that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Funnel - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Funnel + - A list or tuple of dicts of string/value properties that will be passed to the Funnel constructor Returns @@ -350,8 +365,9 @@ 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_objects.layout.template.data.Heatmap - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Heatmap + - A list or tuple of dicts of string/value properties that will be passed to the Heatmap constructor Returns @@ -369,8 +385,9 @@ 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_objects.layout.template.data.Histogram2dContour - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Histogram2dContour + - A list or tuple of dicts of string/value properties that will be passed to the Histogram2dContour constructor Returns @@ -388,8 +405,9 @@ 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_objects.layout.template.data.Histogram2d - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Histogram2d + - A list or tuple of dicts of string/value properties that will be passed to the Histogram2d constructor Returns @@ -407,8 +425,9 @@ 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_objects.layout.template.data.Histogram - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Histogram + - A list or tuple of dicts of string/value properties that will be passed to the Histogram constructor Returns @@ -426,8 +445,9 @@ def icicle(self): """ The 'icicle' property is a tuple of instances of Icicle that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Icicle - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Icicle + - A list or tuple of dicts of string/value properties that will be passed to the Icicle constructor Returns @@ -445,8 +465,9 @@ def image(self): """ The 'image' property is a tuple of instances of Image that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Image - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Image + - A list or tuple of dicts of string/value properties that will be passed to the Image constructor Returns @@ -464,8 +485,9 @@ def indicator(self): """ The 'indicator' property is a tuple of instances of Indicator that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Indicator - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Indicator + - A list or tuple of dicts of string/value properties that will be passed to the Indicator constructor Returns @@ -483,8 +505,9 @@ 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_objects.layout.template.data.Isosurface - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Isosurface + - A list or tuple of dicts of string/value properties that will be passed to the Isosurface constructor Returns @@ -502,8 +525,9 @@ 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_objects.layout.template.data.Mesh3d - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Mesh3d + - A list or tuple of dicts of string/value properties that will be passed to the Mesh3d constructor Returns @@ -521,8 +545,9 @@ 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_objects.layout.template.data.Ohlc - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Ohlc + - A list or tuple of dicts of string/value properties that will be passed to the Ohlc constructor Returns @@ -540,8 +565,9 @@ 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_objects.layout.template.data.Parcats - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Parcats + - A list or tuple of dicts of string/value properties that will be passed to the Parcats constructor Returns @@ -559,8 +585,9 @@ 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_objects.layout.template.data.Parcoords - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Parcoords + - A list or tuple of dicts of string/value properties that will be passed to the Parcoords constructor Returns @@ -578,8 +605,9 @@ 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_objects.layout.template.data.Pie - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Pie + - A list or tuple of dicts of string/value properties that will be passed to the Pie constructor Returns @@ -597,8 +625,9 @@ 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_objects.layout.template.data.Sankey - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Sankey + - A list or tuple of dicts of string/value properties that will be passed to the Sankey constructor Returns @@ -616,8 +645,9 @@ 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_objects.layout.template.data.Scatter3d - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatter3d + - A list or tuple of dicts of string/value properties that will be passed to the Scatter3d constructor Returns @@ -635,8 +665,9 @@ 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_objects.layout.template.data.Scattercarpet - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattercarpet + - A list or tuple of dicts of string/value properties that will be passed to the Scattercarpet constructor Returns @@ -654,8 +685,9 @@ 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_objects.layout.template.data.Scattergeo - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattergeo + - A list or tuple of dicts of string/value properties that will be passed to the Scattergeo constructor Returns @@ -673,8 +705,9 @@ 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_objects.layout.template.data.Scattergl - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattergl + - A list or tuple of dicts of string/value properties that will be passed to the Scattergl constructor Returns @@ -692,8 +725,9 @@ 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_objects.layout.template.data.Scattermapbox - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattermapbox + - A list or tuple of dicts of string/value properties that will be passed to the Scattermapbox constructor Returns @@ -711,8 +745,9 @@ def scattermap(self): """ The 'scattermap' property is a tuple of instances of Scattermap that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattermap - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattermap + - A list or tuple of dicts of string/value properties that will be passed to the Scattermap constructor Returns @@ -730,8 +765,9 @@ 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_objects.layout.template.data.Scatterpolargl - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatterpolargl + - A list or tuple of dicts of string/value properties that will be passed to the Scatterpolargl constructor Returns @@ -749,8 +785,9 @@ 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_objects.layout.template.data.Scatterpolar - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatterpolar + - A list or tuple of dicts of string/value properties that will be passed to the Scatterpolar constructor Returns @@ -768,8 +805,9 @@ 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_objects.layout.template.data.Scatter - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatter + - A list or tuple of dicts of string/value properties that will be passed to the Scatter constructor Returns @@ -787,8 +825,9 @@ def scattersmith(self): """ The 'scattersmith' property is a tuple of instances of Scattersmith that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattersmith - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattersmith + - A list or tuple of dicts of string/value properties that will be passed to the Scattersmith constructor Returns @@ -806,8 +845,9 @@ 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_objects.layout.template.data.Scatterternary - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatterternary + - A list or tuple of dicts of string/value properties that will be passed to the Scatterternary constructor Returns @@ -825,8 +865,9 @@ 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_objects.layout.template.data.Splom - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Splom + - A list or tuple of dicts of string/value properties that will be passed to the Splom constructor Returns @@ -844,8 +885,9 @@ 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_objects.layout.template.data.Streamtube - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Streamtube + - A list or tuple of dicts of string/value properties that will be passed to the Streamtube constructor Returns @@ -863,8 +905,9 @@ def sunburst(self): """ The 'sunburst' property is a tuple of instances of Sunburst that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Sunburst - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Sunburst + - A list or tuple of dicts of string/value properties that will be passed to the Sunburst constructor Returns @@ -882,8 +925,9 @@ 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_objects.layout.template.data.Surface - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Surface + - A list or tuple of dicts of string/value properties that will be passed to the Surface constructor Returns @@ -901,8 +945,9 @@ 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_objects.layout.template.data.Table - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Table + - A list or tuple of dicts of string/value properties that will be passed to the Table constructor Returns @@ -920,8 +965,9 @@ def treemap(self): """ The 'treemap' property is a tuple of instances of Treemap that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Treemap - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Treemap + - A list or tuple of dicts of string/value properties that will be passed to the Treemap constructor Returns @@ -939,8 +985,9 @@ 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_objects.layout.template.data.Violin - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Violin + - A list or tuple of dicts of string/value properties that will be passed to the Violin constructor Returns @@ -958,8 +1005,9 @@ def volume(self): """ The 'volume' property is a tuple of instances of Volume that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Volume - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Volume + - A list or tuple of dicts of string/value properties that will be passed to the Volume constructor Returns @@ -977,8 +1025,9 @@ def waterfall(self): """ The 'waterfall' property is a tuple of instances of Waterfall that may be specified as: - - A list or tuple of instances of plotly.graph_objects.layout.template.data.Waterfall - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.template.data.Waterfall + - A list or tuple of dicts of string/value properties that will be passed to the Waterfall constructor Returns diff --git a/plotly/graph_objects/layout/ternary/_aaxis.py b/plotly/graph_objects/layout/ternary/_aaxis.py index 4b815598f7..96a51e8724 100644 --- a/plotly/graph_objects/layout/ternary/_aaxis.py +++ b/plotly/graph_objects/layout/ternary/_aaxis.py @@ -61,11 +61,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -123,8 +124,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -142,11 +145,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -167,10 +171,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -188,7 +196,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -215,8 +224,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -264,8 +275,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -283,11 +296,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -305,7 +319,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -325,7 +340,8 @@ def min(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -344,7 +360,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -365,7 +382,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -405,8 +423,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -482,8 +502,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -501,8 +523,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -567,11 +591,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -590,9 +615,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -619,8 +644,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -637,8 +664,9 @@ 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_objects.layout.ternary.aaxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.ternary.aaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -661,9 +689,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -686,7 +714,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -705,7 +734,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -729,8 +759,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -748,8 +780,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -769,8 +803,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -788,8 +824,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -882,7 +920,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -899,9 +938,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- diff --git a/plotly/graph_objects/layout/ternary/_baxis.py b/plotly/graph_objects/layout/ternary/_baxis.py index 75a6677cd5..ec75cc7b2c 100644 --- a/plotly/graph_objects/layout/ternary/_baxis.py +++ b/plotly/graph_objects/layout/ternary/_baxis.py @@ -61,11 +61,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -123,8 +124,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -142,11 +145,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -167,10 +171,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -188,7 +196,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -215,8 +224,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -264,8 +275,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -283,11 +296,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -305,7 +319,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -325,7 +340,8 @@ def min(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -344,7 +360,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -365,7 +382,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -405,8 +423,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -482,8 +502,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -501,8 +523,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -567,11 +591,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -590,9 +615,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -619,8 +644,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -637,8 +664,9 @@ 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_objects.layout.ternary.baxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.ternary.baxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -661,9 +689,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -686,7 +714,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -705,7 +734,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -729,8 +759,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -748,8 +780,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -769,8 +803,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -788,8 +824,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -882,7 +920,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -899,9 +938,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- diff --git a/plotly/graph_objects/layout/ternary/_caxis.py b/plotly/graph_objects/layout/ternary/_caxis.py index d413e7ad5c..c061381abb 100644 --- a/plotly/graph_objects/layout/ternary/_caxis.py +++ b/plotly/graph_objects/layout/ternary/_caxis.py @@ -61,11 +61,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -123,8 +124,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -142,11 +145,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -167,10 +171,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -188,7 +196,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -215,8 +224,10 @@ def hoverformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -264,8 +275,10 @@ def layer(self): 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'] + + - One of the following enumeration values: + + ['above traces', 'below traces'] Returns ------- @@ -283,11 +296,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -305,7 +319,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -325,7 +340,8 @@ def min(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -344,7 +360,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -365,7 +382,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -405,8 +423,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -482,8 +502,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -501,8 +523,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -567,11 +591,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -590,9 +615,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -619,8 +644,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -637,8 +664,9 @@ 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_objects.layout.ternary.caxis.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.ternary.caxis.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -661,9 +689,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -686,7 +714,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -705,7 +734,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -729,8 +759,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -748,8 +780,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -769,8 +803,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -788,8 +824,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -882,7 +920,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -899,9 +938,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- diff --git a/plotly/graph_objects/layout/ternary/_domain.py b/plotly/graph_objects/layout/ternary/_domain.py index 676854d2cc..96cae57f34 100644 --- a/plotly/graph_objects/layout/ternary/_domain.py +++ b/plotly/graph_objects/layout/ternary/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/layout/ternary/aaxis/_tickfont.py b/plotly/graph_objects/layout/ternary/aaxis/_tickfont.py index 1a0efdbd54..f9ae271514 100644 --- a/plotly/graph_objects/layout/ternary/aaxis/_tickfont.py +++ b/plotly/graph_objects/layout/ternary/aaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/ternary/aaxis/_tickformatstop.py b/plotly/graph_objects/layout/ternary/aaxis/_tickformatstop.py index 32e8ed92d0..f96f80d3a6 100644 --- a/plotly/graph_objects/layout/ternary/aaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/ternary/aaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/ternary/aaxis/_title.py b/plotly/graph_objects/layout/ternary/aaxis/_title.py index 921bee1b3c..0708621828 100644 --- a/plotly/graph_objects/layout/ternary/aaxis/_title.py +++ b/plotly/graph_objects/layout/ternary/aaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.aaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/ternary/aaxis/title/_font.py b/plotly/graph_objects/layout/ternary/aaxis/title/_font.py index 8e1c135340..f69f2d4e17 100644 --- a/plotly/graph_objects/layout/ternary/aaxis/title/_font.py +++ b/plotly/graph_objects/layout/ternary/aaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/ternary/baxis/_tickfont.py b/plotly/graph_objects/layout/ternary/baxis/_tickfont.py index 0d97736600..692a773a16 100644 --- a/plotly/graph_objects/layout/ternary/baxis/_tickfont.py +++ b/plotly/graph_objects/layout/ternary/baxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/ternary/baxis/_tickformatstop.py b/plotly/graph_objects/layout/ternary/baxis/_tickformatstop.py index 6fd8e863a6..1befcc2636 100644 --- a/plotly/graph_objects/layout/ternary/baxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/ternary/baxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/ternary/baxis/_title.py b/plotly/graph_objects/layout/ternary/baxis/_title.py index 6f6dc6c1fc..7b9d6cd380 100644 --- a/plotly/graph_objects/layout/ternary/baxis/_title.py +++ b/plotly/graph_objects/layout/ternary/baxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.baxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/ternary/baxis/title/_font.py b/plotly/graph_objects/layout/ternary/baxis/title/_font.py index 0fbbc277ad..4c3cea455c 100644 --- a/plotly/graph_objects/layout/ternary/baxis/title/_font.py +++ b/plotly/graph_objects/layout/ternary/baxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/ternary/caxis/_tickfont.py b/plotly/graph_objects/layout/ternary/caxis/_tickfont.py index 350f2a8ca1..fbd8dee9ff 100644 --- a/plotly/graph_objects/layout/ternary/caxis/_tickfont.py +++ b/plotly/graph_objects/layout/ternary/caxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/ternary/caxis/_tickformatstop.py b/plotly/graph_objects/layout/ternary/caxis/_tickformatstop.py index f91544eb0b..6887126be2 100644 --- a/plotly/graph_objects/layout/ternary/caxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/ternary/caxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/ternary/caxis/_title.py b/plotly/graph_objects/layout/ternary/caxis/_title.py index 0fe5e6e3df..29a669cf70 100644 --- a/plotly/graph_objects/layout/ternary/caxis/_title.py +++ b/plotly/graph_objects/layout/ternary/caxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.ternary.caxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/ternary/caxis/title/_font.py b/plotly/graph_objects/layout/ternary/caxis/title/_font.py index be4fd02f42..e1c98922a3 100644 --- a/plotly/graph_objects/layout/ternary/caxis/title/_font.py +++ b/plotly/graph_objects/layout/ternary/caxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/title/_font.py b/plotly/graph_objects/layout/title/_font.py index 86d00b016d..cff9f3d8ba 100644 --- a/plotly/graph_objects/layout/title/_font.py +++ b/plotly/graph_objects/layout/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/title/_pad.py b/plotly/graph_objects/layout/title/_pad.py index bf338c4224..40d2a78d3d 100644 --- a/plotly/graph_objects/layout/title/_pad.py +++ b/plotly/graph_objects/layout/title/_pad.py @@ -18,7 +18,7 @@ def b(self): The 'b' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -38,7 +38,7 @@ def l(self): The 'l' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -58,7 +58,7 @@ def r(self): The 'r' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -77,7 +77,7 @@ def t(self): The 't' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/title/_subtitle.py b/plotly/graph_objects/layout/title/_subtitle.py index 13b9c3f2e5..80b7e7ba8b 100644 --- a/plotly/graph_objects/layout/title/_subtitle.py +++ b/plotly/graph_objects/layout/title/_subtitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.title.subtitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.title.subtitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the plot's subtitle. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/title/subtitle/_font.py b/plotly/graph_objects/layout/title/subtitle/_font.py index 894789bf68..d9ae50c562 100644 --- a/plotly/graph_objects/layout/title/subtitle/_font.py +++ b/plotly/graph_objects/layout/title/subtitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/updatemenu/_button.py b/plotly/graph_objects/layout/updatemenu/_button.py index 073bc121e7..80665391de 100644 --- a/plotly/graph_objects/layout/updatemenu/_button.py +++ b/plotly/graph_objects/layout/updatemenu/_button.py @@ -102,8 +102,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -125,8 +127,10 @@ def method(self): 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'] + + - One of the following enumeration values: + + ['restyle', 'relayout', 'animate', 'update', 'skip'] Returns ------- @@ -150,8 +154,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -176,8 +182,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/updatemenu/_font.py b/plotly/graph_objects/layout/updatemenu/_font.py index 7dfc0ac765..828092d102 100644 --- a/plotly/graph_objects/layout/updatemenu/_font.py +++ b/plotly/graph_objects/layout/updatemenu/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/updatemenu/_pad.py b/plotly/graph_objects/layout/updatemenu/_pad.py index 3141353b1b..3421780439 100644 --- a/plotly/graph_objects/layout/updatemenu/_pad.py +++ b/plotly/graph_objects/layout/updatemenu/_pad.py @@ -18,7 +18,7 @@ def b(self): The 'b' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -38,7 +38,7 @@ def l(self): The 'l' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -58,7 +58,7 @@ def r(self): The 'r' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -77,7 +77,7 @@ def t(self): The 't' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/_minor.py b/plotly/graph_objects/layout/xaxis/_minor.py index 69e094ca53..26805c691a 100644 --- a/plotly/graph_objects/layout/xaxis/_minor.py +++ b/plotly/graph_objects/layout/xaxis/_minor.py @@ -67,11 +67,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -92,10 +93,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -113,7 +118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -134,7 +140,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -197,11 +204,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -219,7 +227,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -243,8 +252,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -264,8 +275,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -320,7 +333,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/_rangebreak.py b/plotly/graph_objects/layout/xaxis/_rangebreak.py index d37c810d47..5af33f6cb4 100644 --- a/plotly/graph_objects/layout/xaxis/_rangebreak.py +++ b/plotly/graph_objects/layout/xaxis/_rangebreak.py @@ -49,7 +49,8 @@ def dvalue(self): milliseconds. The 'dvalue' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -92,8 +93,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -120,8 +123,10 @@ def pattern(self): 5pm to 8am (i.e. skips non-work hours). The 'pattern' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['day of week', 'hour', ''] + + - One of the following enumeration values: + + ['day of week', 'hour', ''] Returns ------- @@ -146,8 +151,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -167,8 +174,10 @@ def values(self): values along the axis. The 'values' property is an info array that may be specified as: + * a list of elements where: - The 'values[i]' property accepts values of any type + + The 'values[i]' property accepts values of any type Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/_rangeselector.py b/plotly/graph_objects/layout/xaxis/_rangeselector.py index ea9e766370..0e9d79dd3d 100644 --- a/plotly/graph_objects/layout/xaxis/_rangeselector.py +++ b/plotly/graph_objects/layout/xaxis/_rangeselector.py @@ -29,11 +29,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -51,11 +52,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -73,11 +75,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -96,7 +99,8 @@ def borderwidth(self): selector. The 'borderwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -116,8 +120,9 @@ 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_objects.layout.xaxis.rangeselector.Button - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.layout.xaxis.rangeselector.Button + - A list or tuple of dicts of string/value properties that will be passed to the Button constructor Returns @@ -140,9 +145,9 @@ def buttondefaults(self): The 'buttondefaults' property is an instance of Button that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.rangeselector.Button` - - A dict of string/value properties that will be passed - to the Button constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.rangeselector.Button` + - A dict of string/value properties that will be passed to the Button constructor Returns ------- @@ -161,9 +166,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.rangeselector.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.rangeselector.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -202,7 +207,8 @@ def x(self): selector. The 'x' property is a number and may be specified as: - - An int or float in the interval [-2, 3] + + - An int or float in the interval [-2, 3] Returns ------- @@ -222,8 +228,10 @@ def xanchor(self): "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'] + + - One of the following enumeration values: + + ['auto', 'left', 'center', 'right'] Returns ------- @@ -242,7 +250,8 @@ def y(self): selector. The 'y' property is a number and may be specified as: - - An int or float in the interval [-2, 3] + + - An int or float in the interval [-2, 3] Returns ------- @@ -262,8 +271,10 @@ def yanchor(self): the range selector. The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['auto', 'top', 'middle', 'bottom'] Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/_rangeslider.py b/plotly/graph_objects/layout/xaxis/_rangeslider.py index 053307a8ee..17d03733e7 100644 --- a/plotly/graph_objects/layout/xaxis/_rangeslider.py +++ b/plotly/graph_objects/layout/xaxis/_rangeslider.py @@ -45,11 +45,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -67,11 +68,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -89,7 +91,8 @@ 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -139,7 +142,8 @@ def thickness(self): area height. The 'thickness' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -175,9 +179,9 @@ def yaxis(self): """ The 'yaxis' property is an instance of YAxis that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.rangeslider.YAxis` - - A dict of string/value properties that will be passed - to the YAxis constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.rangeslider.YAxis` + - A dict of string/value properties that will be passed to the YAxis constructor Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/_tickfont.py b/plotly/graph_objects/layout/xaxis/_tickfont.py index 73f41b84f5..e7e43fab20 100644 --- a/plotly/graph_objects/layout/xaxis/_tickfont.py +++ b/plotly/graph_objects/layout/xaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/xaxis/_tickformatstop.py b/plotly/graph_objects/layout/xaxis/_tickformatstop.py index aede087f8e..35922f35d7 100644 --- a/plotly/graph_objects/layout/xaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/xaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/_title.py b/plotly/graph_objects/layout/xaxis/_title.py index 8ad61b0b8e..fc9fe3059f 100644 --- a/plotly/graph_objects/layout/xaxis/_title.py +++ b/plotly/graph_objects/layout/xaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.xaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.xaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -44,7 +44,8 @@ def standoff(self): title at given standoff distance. The 'standoff' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -62,8 +63,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/rangeselector/_button.py b/plotly/graph_objects/layout/xaxis/rangeselector/_button.py index aea4e5a862..9ca667dabc 100644 --- a/plotly/graph_objects/layout/xaxis/rangeselector/_button.py +++ b/plotly/graph_objects/layout/xaxis/rangeselector/_button.py @@ -25,7 +25,8 @@ def count(self): `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] + + - An int or float in the interval [0, inf] Returns ------- @@ -43,8 +44,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -68,8 +71,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -88,9 +93,10 @@ def step(self): 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'] + + - One of the following enumeration values: + + ['month', 'year', 'day', 'hour', 'minute', 'second', 'all'] Returns ------- @@ -116,8 +122,10 @@ def stepmode(self): calendar. The 'stepmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['backward', 'todate'] + + - One of the following enumeration values: + + ['backward', 'todate'] Returns ------- @@ -142,8 +150,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/rangeselector/_font.py b/plotly/graph_objects/layout/xaxis/rangeselector/_font.py index 11e04a4853..7c3a13ec0e 100644 --- a/plotly/graph_objects/layout/xaxis/rangeselector/_font.py +++ b/plotly/graph_objects/layout/xaxis/rangeselector/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/xaxis/rangeslider/_yaxis.py b/plotly/graph_objects/layout/xaxis/rangeslider/_yaxis.py index ef9f7f39f3..0a3ca81de6 100644 --- a/plotly/graph_objects/layout/xaxis/rangeslider/_yaxis.py +++ b/plotly/graph_objects/layout/xaxis/rangeslider/_yaxis.py @@ -43,8 +43,10 @@ def rangemode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'fixed', 'match'] Returns ------- diff --git a/plotly/graph_objects/layout/xaxis/title/_font.py b/plotly/graph_objects/layout/xaxis/title/_font.py index cf9dd55677..fd46f22b59 100644 --- a/plotly/graph_objects/layout/xaxis/title/_font.py +++ b/plotly/graph_objects/layout/xaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/yaxis/_minor.py b/plotly/graph_objects/layout/yaxis/_minor.py index 9cbf71d773..0647e70732 100644 --- a/plotly/graph_objects/layout/yaxis/_minor.py +++ b/plotly/graph_objects/layout/yaxis/_minor.py @@ -67,11 +67,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -92,10 +93,14 @@ def griddash(self): "5px,10px,2px,2px"). The 'griddash' 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.) + + - 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 ------- @@ -113,7 +118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -134,7 +140,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -197,11 +204,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -219,7 +227,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -243,8 +252,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -264,8 +275,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -320,7 +333,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/layout/yaxis/_rangebreak.py b/plotly/graph_objects/layout/yaxis/_rangebreak.py index fafbbd7706..dd80f7ce0a 100644 --- a/plotly/graph_objects/layout/yaxis/_rangebreak.py +++ b/plotly/graph_objects/layout/yaxis/_rangebreak.py @@ -49,7 +49,8 @@ def dvalue(self): milliseconds. The 'dvalue' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -92,8 +93,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -120,8 +123,10 @@ def pattern(self): 5pm to 8am (i.e. skips non-work hours). The 'pattern' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['day of week', 'hour', ''] + + - One of the following enumeration values: + + ['day of week', 'hour', ''] Returns ------- @@ -146,8 +151,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -167,8 +174,10 @@ def values(self): values along the axis. The 'values' property is an info array that may be specified as: + * a list of elements where: - The 'values[i]' property accepts values of any type + + The 'values[i]' property accepts values of any type Returns ------- diff --git a/plotly/graph_objects/layout/yaxis/_tickfont.py b/plotly/graph_objects/layout/yaxis/_tickfont.py index 32fe2327aa..e14e33ca55 100644 --- a/plotly/graph_objects/layout/yaxis/_tickfont.py +++ b/plotly/graph_objects/layout/yaxis/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/layout/yaxis/_tickformatstop.py b/plotly/graph_objects/layout/yaxis/_tickformatstop.py index dcf3bfe770..092dafcef0 100644 --- a/plotly/graph_objects/layout/yaxis/_tickformatstop.py +++ b/plotly/graph_objects/layout/yaxis/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/yaxis/_title.py b/plotly/graph_objects/layout/yaxis/_title.py index 924858239c..1c3bc70960 100644 --- a/plotly/graph_objects/layout/yaxis/_title.py +++ b/plotly/graph_objects/layout/yaxis/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.layout.yaxis.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.layout.yaxis.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -44,7 +44,8 @@ def standoff(self): title at given standoff distance. The 'standoff' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -62,8 +63,10 @@ def text(self): Sets the title of this axis. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/layout/yaxis/title/_font.py b/plotly/graph_objects/layout/yaxis/title/_font.py index fdfec30be1..93edb186e6 100644 --- a/plotly/graph_objects/layout/yaxis/title/_font.py +++ b/plotly/graph_objects/layout/yaxis/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseLayoutHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/mesh3d/_colorbar.py b/plotly/graph_objects/mesh3d/_colorbar.py index efbae00979..dddaee9f96 100644 --- a/plotly/graph_objects/mesh3d/_colorbar.py +++ b/plotly/graph_objects/mesh3d/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.mesh3d.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.mesh3d.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/mesh3d/_contour.py b/plotly/graph_objects/mesh3d/_contour.py index 6b75e49277..e3ab358f76 100644 --- a/plotly/graph_objects/mesh3d/_contour.py +++ b/plotly/graph_objects/mesh3d/_contour.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -56,7 +57,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- diff --git a/plotly/graph_objects/mesh3d/_hoverlabel.py b/plotly/graph_objects/mesh3d/_hoverlabel.py index d0a4dd3352..e5dc116f81 100644 --- a/plotly/graph_objects/mesh3d/_hoverlabel.py +++ b/plotly/graph_objects/mesh3d/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/mesh3d/_legendgrouptitle.py b/plotly/graph_objects/mesh3d/_legendgrouptitle.py index 369aa74a6d..6bc516546e 100644 --- a/plotly/graph_objects/mesh3d/_legendgrouptitle.py +++ b/plotly/graph_objects/mesh3d/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/mesh3d/_lighting.py b/plotly/graph_objects/mesh3d/_lighting.py index 4ee5187543..38d55f2245 100644 --- a/plotly/graph_objects/mesh3d/_lighting.py +++ b/plotly/graph_objects/mesh3d/_lighting.py @@ -25,7 +25,8 @@ def ambient(self): out the image. The 'ambient' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -44,7 +45,8 @@ def diffuse(self): range of angles. The 'diffuse' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -63,7 +65,8 @@ def facenormalsepsilon(self): from degenerate geometry. The 'facenormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -83,7 +86,8 @@ def fresnel(self): 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] + + - An int or float in the interval [0, 5] Returns ------- @@ -102,7 +106,8 @@ def roughness(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -121,7 +126,8 @@ def specular(self): single direction, causing shine. The 'specular' property is a number and may be specified as: - - An int or float in the interval [0, 2] + + - An int or float in the interval [0, 2] Returns ------- @@ -140,7 +146,8 @@ def vertexnormalsepsilon(self): arising from degenerate geometry. The 'vertexnormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/mesh3d/_lightposition.py b/plotly/graph_objects/mesh3d/_lightposition.py index a366b4cc90..202f6e20e2 100644 --- a/plotly/graph_objects/mesh3d/_lightposition.py +++ b/plotly/graph_objects/mesh3d/_lightposition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -34,7 +35,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -52,7 +54,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- diff --git a/plotly/graph_objects/mesh3d/_stream.py b/plotly/graph_objects/mesh3d/_stream.py index e3f5f3287f..d006a71266 100644 --- a/plotly/graph_objects/mesh3d/_stream.py +++ b/plotly/graph_objects/mesh3d/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/mesh3d/colorbar/_tickfont.py b/plotly/graph_objects/mesh3d/colorbar/_tickfont.py index 3972c6c046..40b23e352b 100644 --- a/plotly/graph_objects/mesh3d/colorbar/_tickfont.py +++ b/plotly/graph_objects/mesh3d/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/mesh3d/colorbar/_tickformatstop.py b/plotly/graph_objects/mesh3d/colorbar/_tickformatstop.py index e5b60af774..b87ef8fe2c 100644 --- a/plotly/graph_objects/mesh3d/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/mesh3d/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/mesh3d/colorbar/_title.py b/plotly/graph_objects/mesh3d/colorbar/_title.py index d36885c6db..0b7a6b0fbd 100644 --- a/plotly/graph_objects/mesh3d/colorbar/_title.py +++ b/plotly/graph_objects/mesh3d/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.mesh3d.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/mesh3d/colorbar/title/_font.py b/plotly/graph_objects/mesh3d/colorbar/title/_font.py index 463493af10..5c1be97c23 100644 --- a/plotly/graph_objects/mesh3d/colorbar/title/_font.py +++ b/plotly/graph_objects/mesh3d/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/mesh3d/hoverlabel/_font.py b/plotly/graph_objects/mesh3d/hoverlabel/_font.py index 53fc249d2a..6755767821 100644 --- a/plotly/graph_objects/mesh3d/hoverlabel/_font.py +++ b/plotly/graph_objects/mesh3d/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/mesh3d/legendgrouptitle/_font.py b/plotly/graph_objects/mesh3d/legendgrouptitle/_font.py index fbcc1390da..01fddd0e3a 100644 --- a/plotly/graph_objects/mesh3d/legendgrouptitle/_font.py +++ b/plotly/graph_objects/mesh3d/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/ohlc/_decreasing.py b/plotly/graph_objects/ohlc/_decreasing.py index c2b4db2021..d9c8699221 100644 --- a/plotly/graph_objects/ohlc/_decreasing.py +++ b/plotly/graph_objects/ohlc/_decreasing.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.decreasing.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.ohlc.decreasing.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/ohlc/_hoverlabel.py b/plotly/graph_objects/ohlc/_hoverlabel.py index b38cdffa44..b386c17faf 100644 --- a/plotly/graph_objects/ohlc/_hoverlabel.py +++ b/plotly/graph_objects/ohlc/_hoverlabel.py @@ -29,9 +29,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -67,12 +70,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -108,12 +112,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -151,9 +156,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.ohlc.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -176,7 +181,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/ohlc/_increasing.py b/plotly/graph_objects/ohlc/_increasing.py index f334837aa0..8d426b32f1 100644 --- a/plotly/graph_objects/ohlc/_increasing.py +++ b/plotly/graph_objects/ohlc/_increasing.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.increasing.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.ohlc.increasing.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/ohlc/_legendgrouptitle.py b/plotly/graph_objects/ohlc/_legendgrouptitle.py index bdee0e3217..3c2c92602c 100644 --- a/plotly/graph_objects/ohlc/_legendgrouptitle.py +++ b/plotly/graph_objects/ohlc/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.ohlc.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.ohlc.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/ohlc/_line.py b/plotly/graph_objects/ohlc/_line.py index 5423326e0a..c4c0dad5bf 100644 --- a/plotly/graph_objects/ohlc/_line.py +++ b/plotly/graph_objects/ohlc/_line.py @@ -21,10 +21,14 @@ def dash(self): `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.) + + - 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 ------- @@ -44,7 +48,8 @@ def width(self): `decreasing.line.width`. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/ohlc/_stream.py b/plotly/graph_objects/ohlc/_stream.py index 1a48de9354..f4cf876124 100644 --- a/plotly/graph_objects/ohlc/_stream.py +++ b/plotly/graph_objects/ohlc/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/ohlc/decreasing/_line.py b/plotly/graph_objects/ohlc/decreasing/_line.py index 8fe35879ae..eb93b5e198 100644 --- a/plotly/graph_objects/ohlc/decreasing/_line.py +++ b/plotly/graph_objects/ohlc/decreasing/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/ohlc/hoverlabel/_font.py b/plotly/graph_objects/ohlc/hoverlabel/_font.py index acf00b2c5b..b45f8344a1 100644 --- a/plotly/graph_objects/ohlc/hoverlabel/_font.py +++ b/plotly/graph_objects/ohlc/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/ohlc/increasing/_line.py b/plotly/graph_objects/ohlc/increasing/_line.py index 2d260422bd..f1aabacd7f 100644 --- a/plotly/graph_objects/ohlc/increasing/_line.py +++ b/plotly/graph_objects/ohlc/increasing/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/ohlc/legendgrouptitle/_font.py b/plotly/graph_objects/ohlc/legendgrouptitle/_font.py index 86c04ecdb6..f76a0840a7 100644 --- a/plotly/graph_objects/ohlc/legendgrouptitle/_font.py +++ b/plotly/graph_objects/ohlc/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcats/_dimension.py b/plotly/graph_objects/parcats/_dimension.py index 73252a5809..b34e9570a8 100644 --- a/plotly/graph_objects/parcats/_dimension.py +++ b/plotly/graph_objects/parcats/_dimension.py @@ -76,9 +76,11 @@ def categoryorder(self): `categoryarray`. The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] + + - One of the following enumeration values: + + ['trace', 'category ascending', 'category descending', + 'array'] Returns ------- @@ -97,7 +99,8 @@ def displayindex(self): 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) + + - An int (or float that will be cast to an int) Returns ------- @@ -115,8 +118,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcats/_domain.py b/plotly/graph_objects/parcats/_domain.py index 25b36a893a..7319f3b583 100644 --- a/plotly/graph_objects/parcats/_domain.py +++ b/plotly/graph_objects/parcats/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/parcats/_labelfont.py b/plotly/graph_objects/parcats/_labelfont.py index a40cdb7c01..f8823db60c 100644 --- a/plotly/graph_objects/parcats/_labelfont.py +++ b/plotly/graph_objects/parcats/_labelfont.py @@ -24,11 +24,12 @@ class Labelfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcats/_legendgrouptitle.py b/plotly/graph_objects/parcats/_legendgrouptitle.py index 13bb84c5d1..fe11c9b5c6 100644 --- a/plotly/graph_objects/parcats/_legendgrouptitle.py +++ b/plotly/graph_objects/parcats/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.parcats.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcats/_line.py b/plotly/graph_objects/parcats/_line.py index 12a7e94cb5..9367d1d0be 100644 --- a/plotly/graph_objects/parcats/_line.py +++ b/plotly/graph_objects/parcats/_line.py @@ -81,7 +81,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to parcats.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to parcats.line.colorscale + - A list or array of any of the above Returns ------- @@ -196,9 +196,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.line.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.parcats.line.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -227,30 +227,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -311,8 +312,10 @@ def hovertemplate(self): ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -353,8 +356,10 @@ def shape(self): curved splines The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'hspline'] + + - One of the following enumeration values: + + ['linear', 'hspline'] Returns ------- diff --git a/plotly/graph_objects/parcats/_stream.py b/plotly/graph_objects/parcats/_stream.py index 78c0b1d28e..629ea602c7 100644 --- a/plotly/graph_objects/parcats/_stream.py +++ b/plotly/graph_objects/parcats/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/parcats/_tickfont.py b/plotly/graph_objects/parcats/_tickfont.py index 52b21da7c1..a6a651db75 100644 --- a/plotly/graph_objects/parcats/_tickfont.py +++ b/plotly/graph_objects/parcats/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcats/legendgrouptitle/_font.py b/plotly/graph_objects/parcats/legendgrouptitle/_font.py index 0a9a6dbeee..90c9adf9c4 100644 --- a/plotly/graph_objects/parcats/legendgrouptitle/_font.py +++ b/plotly/graph_objects/parcats/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcats/line/_colorbar.py b/plotly/graph_objects/parcats/line/_colorbar.py index 937c4321bc..cd56b3fc72 100644 --- a/plotly/graph_objects/parcats/line/_colorbar.py +++ b/plotly/graph_objects/parcats/line/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.parcats.line.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.parcats.line.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/parcats/line/colorbar/_tickfont.py b/plotly/graph_objects/parcats/line/colorbar/_tickfont.py index 7b53d52d1d..dcc48a285b 100644 --- a/plotly/graph_objects/parcats/line/colorbar/_tickfont.py +++ b/plotly/graph_objects/parcats/line/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcats/line/colorbar/_tickformatstop.py b/plotly/graph_objects/parcats/line/colorbar/_tickformatstop.py index 6e671c1763..e589e272d0 100644 --- a/plotly/graph_objects/parcats/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/parcats/line/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcats/line/colorbar/_title.py b/plotly/graph_objects/parcats/line/colorbar/_title.py index a90dc7d6b2..878a3c0a86 100644 --- a/plotly/graph_objects/parcats/line/colorbar/_title.py +++ b/plotly/graph_objects/parcats/line/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.parcats.line.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcats/line/colorbar/title/_font.py b/plotly/graph_objects/parcats/line/colorbar/title/_font.py index 79e0e04ceb..b9ec5b93bb 100644 --- a/plotly/graph_objects/parcats/line/colorbar/title/_font.py +++ b/plotly/graph_objects/parcats/line/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/_dimension.py b/plotly/graph_objects/parcoords/_dimension.py index 5fcd0638ed..6e86c361cf 100644 --- a/plotly/graph_objects/parcoords/_dimension.py +++ b/plotly/graph_objects/parcoords/_dimension.py @@ -44,9 +44,9 @@ def constraintrange(self): * a 2D list where: - (0) The 'constraintrange\[i\]\[0\]' property accepts values of any type + (0) The 'constraintrange\\[i\\]\\[0\\]' property accepts values of any type - (1) The 'constraintrange\[i\]\[1\]' property accepts values of any type + (1) The 'constraintrange\\[i\\]\\[1\\]' property accepts values of any type Returns ------- @@ -64,8 +64,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -107,8 +109,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -162,8 +166,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -190,8 +196,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcoords/_domain.py b/plotly/graph_objects/parcoords/_domain.py index 0b5d22cad2..a1c9216cd7 100644 --- a/plotly/graph_objects/parcoords/_domain.py +++ b/plotly/graph_objects/parcoords/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/parcoords/_labelfont.py b/plotly/graph_objects/parcoords/_labelfont.py index 9723adaa4d..8f9e996254 100644 --- a/plotly/graph_objects/parcoords/_labelfont.py +++ b/plotly/graph_objects/parcoords/_labelfont.py @@ -24,11 +24,12 @@ class Labelfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/_legendgrouptitle.py b/plotly/graph_objects/parcoords/_legendgrouptitle.py index 057376e7e4..734ec69ac2 100644 --- a/plotly/graph_objects/parcoords/_legendgrouptitle.py +++ b/plotly/graph_objects/parcoords/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.parcoords.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcoords/_line.py b/plotly/graph_objects/parcoords/_line.py index 8f55583201..a4139e523f 100644 --- a/plotly/graph_objects/parcoords/_line.py +++ b/plotly/graph_objects/parcoords/_line.py @@ -79,7 +79,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -102,7 +102,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -124,7 +124,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -145,14 +145,14 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to parcoords.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to parcoords.line.colorscale + - A list or array of any of the above Returns ------- @@ -194,9 +194,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.line.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.parcoords.line.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -225,30 +225,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- diff --git a/plotly/graph_objects/parcoords/_rangefont.py b/plotly/graph_objects/parcoords/_rangefont.py index 9929759a00..ecdb69ebdd 100644 --- a/plotly/graph_objects/parcoords/_rangefont.py +++ b/plotly/graph_objects/parcoords/_rangefont.py @@ -24,11 +24,12 @@ class Rangefont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/_stream.py b/plotly/graph_objects/parcoords/_stream.py index 3a1cfe1756..335c3229ad 100644 --- a/plotly/graph_objects/parcoords/_stream.py +++ b/plotly/graph_objects/parcoords/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/parcoords/_tickfont.py b/plotly/graph_objects/parcoords/_tickfont.py index 1b0d00ff14..d3e1b3b37b 100644 --- a/plotly/graph_objects/parcoords/_tickfont.py +++ b/plotly/graph_objects/parcoords/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/_unselected.py b/plotly/graph_objects/parcoords/_unselected.py index 6848af0b56..0d31b779a4 100644 --- a/plotly/graph_objects/parcoords/_unselected.py +++ b/plotly/graph_objects/parcoords/_unselected.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.unselected.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.parcoords.unselected.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/parcoords/legendgrouptitle/_font.py b/plotly/graph_objects/parcoords/legendgrouptitle/_font.py index 8877f0cb64..74740ef931 100644 --- a/plotly/graph_objects/parcoords/legendgrouptitle/_font.py +++ b/plotly/graph_objects/parcoords/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/line/_colorbar.py b/plotly/graph_objects/parcoords/line/_colorbar.py index 144e4686f5..caddba62c1 100644 --- a/plotly/graph_objects/parcoords/line/_colorbar.py +++ b/plotly/graph_objects/parcoords/line/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.parcoords.line.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.parcoords.line.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/parcoords/line/colorbar/_tickfont.py b/plotly/graph_objects/parcoords/line/colorbar/_tickfont.py index 731c542fd2..97fea540c8 100644 --- a/plotly/graph_objects/parcoords/line/colorbar/_tickfont.py +++ b/plotly/graph_objects/parcoords/line/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/line/colorbar/_tickformatstop.py b/plotly/graph_objects/parcoords/line/colorbar/_tickformatstop.py index fd7ec0d2e2..90ac7aa77c 100644 --- a/plotly/graph_objects/parcoords/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/parcoords/line/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcoords/line/colorbar/_title.py b/plotly/graph_objects/parcoords/line/colorbar/_title.py index 785c3c677a..e508c1f264 100644 --- a/plotly/graph_objects/parcoords/line/colorbar/_title.py +++ b/plotly/graph_objects/parcoords/line/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.parcoords.line.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/parcoords/line/colorbar/title/_font.py b/plotly/graph_objects/parcoords/line/colorbar/title/_font.py index 8eb1e1facc..6a49be6c2d 100644 --- a/plotly/graph_objects/parcoords/line/colorbar/title/_font.py +++ b/plotly/graph_objects/parcoords/line/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/parcoords/unselected/_line.py b/plotly/graph_objects/parcoords/unselected/_line.py index 6356757f94..7440122f34 100644 --- a/plotly/graph_objects/parcoords/unselected/_line.py +++ b/plotly/graph_objects/parcoords/unselected/_line.py @@ -17,11 +17,12 @@ def color(self): `unselected.line.opacity`. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,7 +42,8 @@ def opacity(self): increases. Use 1 to achieve exact `unselected.line.color`. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/pie/_domain.py b/plotly/graph_objects/pie/_domain.py index e360e56c1e..bc209b03e6 100644 --- a/plotly/graph_objects/pie/_domain.py +++ b/plotly/graph_objects/pie/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -86,10 +90,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/pie/_hoverlabel.py b/plotly/graph_objects/pie/_hoverlabel.py index 8e85c15387..c3f6c2615d 100644 --- a/plotly/graph_objects/pie/_hoverlabel.py +++ b/plotly/graph_objects/pie/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.pie.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/pie/_insidetextfont.py b/plotly/graph_objects/pie/_insidetextfont.py index 96115b28e2..556de9a764 100644 --- a/plotly/graph_objects/pie/_insidetextfont.py +++ b/plotly/graph_objects/pie/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/pie/_legendgrouptitle.py b/plotly/graph_objects/pie/_legendgrouptitle.py index 82bc443c67..6fe994fadc 100644 --- a/plotly/graph_objects/pie/_legendgrouptitle.py +++ b/plotly/graph_objects/pie/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.pie.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/pie/_marker.py b/plotly/graph_objects/pie/_marker.py index 19ea6c61fd..baf8ed17ed 100644 --- a/plotly/graph_objects/pie/_marker.py +++ b/plotly/graph_objects/pie/_marker.py @@ -52,9 +52,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.pie.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -73,9 +73,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.pie.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/pie/_outsidetextfont.py b/plotly/graph_objects/pie/_outsidetextfont.py index 23a0b1b37c..48fd991737 100644 --- a/plotly/graph_objects/pie/_outsidetextfont.py +++ b/plotly/graph_objects/pie/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/pie/_stream.py b/plotly/graph_objects/pie/_stream.py index b18c03eefc..959fda6339 100644 --- a/plotly/graph_objects/pie/_stream.py +++ b/plotly/graph_objects/pie/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/pie/_textfont.py b/plotly/graph_objects/pie/_textfont.py index 5de3a6358b..e1d32446ff 100644 --- a/plotly/graph_objects/pie/_textfont.py +++ b/plotly/graph_objects/pie/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/pie/_title.py b/plotly/graph_objects/pie/_title.py index f4e7ed9641..d47c2adbb1 100644 --- a/plotly/graph_objects/pie/_title.py +++ b/plotly/graph_objects/pie/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.pie.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.pie.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,9 +37,11 @@ def position(self): Specifies the location of the `title`. 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'] + + - One of the following enumeration values: + + ['top left', 'top center', 'top right', 'middle center', + 'bottom left', 'bottom center', 'bottom right'] Returns ------- @@ -58,8 +60,10 @@ def text(self): displayed. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/pie/hoverlabel/_font.py b/plotly/graph_objects/pie/hoverlabel/_font.py index 0af8b50ca4..9c86d93ddb 100644 --- a/plotly/graph_objects/pie/hoverlabel/_font.py +++ b/plotly/graph_objects/pie/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/pie/legendgrouptitle/_font.py b/plotly/graph_objects/pie/legendgrouptitle/_font.py index 1e515833c8..868b420c7e 100644 --- a/plotly/graph_objects/pie/legendgrouptitle/_font.py +++ b/plotly/graph_objects/pie/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/pie/marker/_line.py b/plotly/graph_objects/pie/marker/_line.py index ffa6c90d94..c47117cd65 100644 --- a/plotly/graph_objects/pie/marker/_line.py +++ b/plotly/graph_objects/pie/marker/_line.py @@ -16,12 +16,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -57,8 +58,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/pie/marker/_pattern.py b/plotly/graph_objects/pie/marker/_pattern.py index 5c13ae253b..d5bac5a19a 100644 --- a/plotly/graph_objects/pie/marker/_pattern.py +++ b/plotly/graph_objects/pie/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/pie/title/_font.py b/plotly/graph_objects/pie/title/_font.py index 892a2e720a..f47d1c5299 100644 --- a/plotly/graph_objects/pie/title/_font.py +++ b/plotly/graph_objects/pie/title/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sankey/_domain.py b/plotly/graph_objects/sankey/_domain.py index 9781dfff1f..a6b51485c4 100644 --- a/plotly/graph_objects/sankey/_domain.py +++ b/plotly/graph_objects/sankey/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/sankey/_hoverlabel.py b/plotly/graph_objects/sankey/_hoverlabel.py index b755c71093..fd8842b110 100644 --- a/plotly/graph_objects/sankey/_hoverlabel.py +++ b/plotly/graph_objects/sankey/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sankey.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/sankey/_legendgrouptitle.py b/plotly/graph_objects/sankey/_legendgrouptitle.py index f99151d7c7..e1c017dac0 100644 --- a/plotly/graph_objects/sankey/_legendgrouptitle.py +++ b/plotly/graph_objects/sankey/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sankey.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/sankey/_link.py b/plotly/graph_objects/sankey/_link.py index 4aad5be3a6..0c8358fd07 100644 --- a/plotly/graph_objects/sankey/_link.py +++ b/plotly/graph_objects/sankey/_link.py @@ -40,7 +40,8 @@ def arrowlen(self): be drawn. The 'arrowlen' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -60,12 +61,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -82,8 +84,9 @@ 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_objects.sankey.link.Colorscale - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.sankey.link.Colorscale + - A list or tuple of dicts of string/value properties that will be passed to the Colorscale constructor Returns @@ -106,9 +109,9 @@ def colorscaledefaults(self): The 'colorscaledefaults' property is an instance of Colorscale that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.link.Colorscale` - - A dict of string/value properties that will be passed - to the Colorscale constructor + + - An instance of :class:`plotly.graph_objects.sankey.link.Colorscale` + - A dict of string/value properties that will be passed to the Colorscale constructor Returns ------- @@ -184,12 +187,13 @@ def hovercolor(self): become slightly more opaque when hovered over. The 'hovercolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -229,8 +233,10 @@ def hoverinfo(self): still fired. The 'hoverinfo' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'none', 'skip'] + + - One of the following enumeration values: + + ['all', 'none', 'skip'] Returns ------- @@ -247,9 +253,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.link.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.sankey.link.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -291,9 +297,12 @@ def hovertemplate(self): secondary box completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -365,9 +374,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.link.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.sankey.link.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/sankey/_node.py b/plotly/graph_objects/sankey/_node.py index 206ef5c964..9d0da90ce4 100644 --- a/plotly/graph_objects/sankey/_node.py +++ b/plotly/graph_objects/sankey/_node.py @@ -37,8 +37,10 @@ def align(self): horizontal axis. The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['justify', 'left', 'right', 'center'] + + - One of the following enumeration values: + + ['justify', 'left', 'right', 'center'] Returns ------- @@ -61,12 +63,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -144,7 +147,7 @@ def groups(self): * a 2D list where: - The 'groups\[i\]\[j\]' property is a number and may be specified as: + The 'groups\\[i\\]\\[j\\]' property is a number and may be specified as: - An int or float @@ -167,8 +170,10 @@ def hoverinfo(self): still fired. The 'hoverinfo' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'none', 'skip'] + + - One of the following enumeration values: + + ['all', 'none', 'skip'] Returns ------- @@ -185,9 +190,9 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.node.Hoverlabel` - - A dict of string/value properties that will be passed - to the Hoverlabel constructor + + - An instance of :class:`plotly.graph_objects.sankey.node.Hoverlabel` + - A dict of string/value properties that will be passed to the Hoverlabel constructor Returns ------- @@ -230,9 +235,12 @@ def hovertemplate(self): completely, use an empty tag ``. The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -304,9 +312,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.node.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.sankey.node.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -324,7 +332,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -342,7 +351,8 @@ 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] + + - An int or float in the interval [1, inf] Returns ------- diff --git a/plotly/graph_objects/sankey/_stream.py b/plotly/graph_objects/sankey/_stream.py index 60a97154fe..3e537a4955 100644 --- a/plotly/graph_objects/sankey/_stream.py +++ b/plotly/graph_objects/sankey/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/sankey/_textfont.py b/plotly/graph_objects/sankey/_textfont.py index d9e060263d..01abf38b21 100644 --- a/plotly/graph_objects/sankey/_textfont.py +++ b/plotly/graph_objects/sankey/_textfont.py @@ -24,11 +24,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/sankey/hoverlabel/_font.py b/plotly/graph_objects/sankey/hoverlabel/_font.py index 6ffb2969a1..e8b269de56 100644 --- a/plotly/graph_objects/sankey/hoverlabel/_font.py +++ b/plotly/graph_objects/sankey/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sankey/legendgrouptitle/_font.py b/plotly/graph_objects/sankey/legendgrouptitle/_font.py index b5465e8bf3..a8a9dd3825 100644 --- a/plotly/graph_objects/sankey/legendgrouptitle/_font.py +++ b/plotly/graph_objects/sankey/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/sankey/link/_colorscale.py b/plotly/graph_objects/sankey/link/_colorscale.py index 279fe47de9..ee12520c3d 100644 --- a/plotly/graph_objects/sankey/link/_colorscale.py +++ b/plotly/graph_objects/sankey/link/_colorscale.py @@ -17,7 +17,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -36,7 +36,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -64,30 +64,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -106,8 +107,10 @@ def label(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -131,8 +134,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -157,8 +162,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/sankey/link/_hoverlabel.py b/plotly/graph_objects/sankey/link/_hoverlabel.py index 390ee0c214..6dd1a86abc 100644 --- a/plotly/graph_objects/sankey/link/_hoverlabel.py +++ b/plotly/graph_objects/sankey/link/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.link.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sankey.link.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/sankey/link/_line.py b/plotly/graph_objects/sankey/link/_line.py index 2cb4b034ba..339f7ba875 100644 --- a/plotly/graph_objects/sankey/link/_line.py +++ b/plotly/graph_objects/sankey/link/_line.py @@ -16,12 +16,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -57,8 +58,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/sankey/link/hoverlabel/_font.py b/plotly/graph_objects/sankey/link/hoverlabel/_font.py index b66e41aab4..75458b2300 100644 --- a/plotly/graph_objects/sankey/link/hoverlabel/_font.py +++ b/plotly/graph_objects/sankey/link/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sankey/node/_hoverlabel.py b/plotly/graph_objects/sankey/node/_hoverlabel.py index 8761b02d81..282e1b2759 100644 --- a/plotly/graph_objects/sankey/node/_hoverlabel.py +++ b/plotly/graph_objects/sankey/node/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sankey.node.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sankey.node.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/sankey/node/_line.py b/plotly/graph_objects/sankey/node/_line.py index a0f4de666f..6028138faa 100644 --- a/plotly/graph_objects/sankey/node/_line.py +++ b/plotly/graph_objects/sankey/node/_line.py @@ -16,12 +16,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -57,8 +58,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/sankey/node/hoverlabel/_font.py b/plotly/graph_objects/sankey/node/hoverlabel/_font.py index 86471a9459..929cb104ae 100644 --- a/plotly/graph_objects/sankey/node/hoverlabel/_font.py +++ b/plotly/graph_objects/sankey/node/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatter/_error_x.py b/plotly/graph_objects/scatter/_error_x.py index a97d8e9ed8..846623a572 100644 --- a/plotly/graph_objects/scatter/_error_x.py +++ b/plotly/graph_objects/scatter/_error_x.py @@ -108,11 +108,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -166,7 +167,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -182,7 +184,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -199,7 +202,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -224,8 +228,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -245,7 +251,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -266,7 +273,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,7 +311,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter/_error_y.py b/plotly/graph_objects/scatter/_error_y.py index 3e12b9ae4b..dc891b86a0 100644 --- a/plotly/graph_objects/scatter/_error_y.py +++ b/plotly/graph_objects/scatter/_error_y.py @@ -107,11 +107,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -149,7 +150,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -165,7 +167,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -182,7 +185,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -207,8 +211,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -228,7 +234,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -249,7 +256,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -286,7 +294,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter/_fillgradient.py b/plotly/graph_objects/scatter/_fillgradient.py index 31aed3ba8f..3f1d203dfd 100644 --- a/plotly/graph_objects/scatter/_fillgradient.py +++ b/plotly/graph_objects/scatter/_fillgradient.py @@ -21,30 +21,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -68,7 +69,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -92,7 +93,7 @@ def stop(self): The 'stop' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -111,8 +112,10 @@ def type(self): Defaults to "none". The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['radial', 'horizontal', 'vertical', 'none'] + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] Returns ------- diff --git a/plotly/graph_objects/scatter/_fillpattern.py b/plotly/graph_objects/scatter/_fillpattern.py index 8340f9f390..b26d02d1a6 100644 --- a/plotly/graph_objects/scatter/_fillpattern.py +++ b/plotly/graph_objects/scatter/_fillpattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatter/_hoverlabel.py b/plotly/graph_objects/scatter/_hoverlabel.py index fd83df7570..476fb0c08c 100644 --- a/plotly/graph_objects/scatter/_hoverlabel.py +++ b/plotly/graph_objects/scatter/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scatter/_legendgrouptitle.py b/plotly/graph_objects/scatter/_legendgrouptitle.py index 34569379c5..7a34410520 100644 --- a/plotly/graph_objects/scatter/_legendgrouptitle.py +++ b/plotly/graph_objects/scatter/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter/_line.py b/plotly/graph_objects/scatter/_line.py index 0a3e483317..12ccd5f539 100644 --- a/plotly/graph_objects/scatter/_line.py +++ b/plotly/graph_objects/scatter/_line.py @@ -28,8 +28,10 @@ def backoff(self): markers if `marker.angleref` is set to "previous". The 'backoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -65,11 +67,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -90,10 +93,14 @@ def dash(self): "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.) + + - 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 ------- @@ -113,8 +120,10 @@ def shape(self): 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'] + + - One of the following enumeration values: + + ['linear', 'spline', 'hv', 'vh', 'hvh', 'vhv'] Returns ------- @@ -155,7 +164,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -173,7 +183,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter/_marker.py b/plotly/graph_objects/scatter/_marker.py index 4c019f0687..098377dfdd 100644 --- a/plotly/graph_objects/scatter/_marker.py +++ b/plotly/graph_objects/scatter/_marker.py @@ -68,8 +68,10 @@ def angleref(self): "up", angle 0 points toward the top of the screen. The 'angleref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['previous', 'up'] + + - One of the following enumeration values: + + ['previous', 'up'] Returns ------- @@ -156,7 +158,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -179,7 +181,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -201,7 +203,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,14 +224,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatter.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scatter.marker.colorscale + - A list or array of any of the above Returns ------- @@ -271,9 +273,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -302,30 +304,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -360,9 +363,9 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.Gradient` - - A dict of string/value properties that will be passed - to the Gradient constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.Gradient` + - A dict of string/value properties that will be passed to the Gradient constructor Returns ------- @@ -379,9 +382,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -400,7 +403,8 @@ def maxdisplayed(self): corresponds to no limit. The 'maxdisplayed' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -418,8 +422,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -496,8 +502,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -517,7 +525,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -537,8 +546,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -559,7 +570,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -598,8 +609,10 @@ def standoff(self): arrowhead marker at it. The 'standoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -638,97 +651,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatter/_selected.py b/plotly/graph_objects/scatter/_selected.py index 90119b46f6..0ab503e8a8 100644 --- a/plotly/graph_objects/scatter/_selected.py +++ b/plotly/graph_objects/scatter/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatter.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatter.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatter/_stream.py b/plotly/graph_objects/scatter/_stream.py index f79c80fa50..f2f40150a9 100644 --- a/plotly/graph_objects/scatter/_stream.py +++ b/plotly/graph_objects/scatter/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scatter/_textfont.py b/plotly/graph_objects/scatter/_textfont.py index 98d665596f..d27e097913 100644 --- a/plotly/graph_objects/scatter/_textfont.py +++ b/plotly/graph_objects/scatter/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatter/_unselected.py b/plotly/graph_objects/scatter/_unselected.py index 3708f71b7d..44864c67d9 100644 --- a/plotly/graph_objects/scatter/_unselected.py +++ b/plotly/graph_objects/scatter/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatter.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatter.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatter/hoverlabel/_font.py b/plotly/graph_objects/scatter/hoverlabel/_font.py index 71ec19abe7..9d6638a4f2 100644 --- a/plotly/graph_objects/scatter/hoverlabel/_font.py +++ b/plotly/graph_objects/scatter/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatter/legendgrouptitle/_font.py b/plotly/graph_objects/scatter/legendgrouptitle/_font.py index 68af679393..7c322c4224 100644 --- a/plotly/graph_objects/scatter/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scatter/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter/marker/_colorbar.py b/plotly/graph_objects/scatter/marker/_colorbar.py index 4ffba10a6c..07d4e361be 100644 --- a/plotly/graph_objects/scatter/marker/_colorbar.py +++ b/plotly/graph_objects/scatter/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scatter.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scatter.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scatter/marker/_gradient.py b/plotly/graph_objects/scatter/marker/_gradient.py index 24c139eaa9..23549592d5 100644 --- a/plotly/graph_objects/scatter/marker/_gradient.py +++ b/plotly/graph_objects/scatter/marker/_gradient.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,9 +59,12 @@ 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 + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatter/marker/_line.py b/plotly/graph_objects/scatter/marker/_line.py index 0a51765098..3f7514dfc4 100644 --- a/plotly/graph_objects/scatter/marker/_line.py +++ b/plotly/graph_objects/scatter/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatter.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatter/marker/colorbar/_tickfont.py b/plotly/graph_objects/scatter/marker/colorbar/_tickfont.py index 97ee002f02..8a2d3073a7 100644 --- a/plotly/graph_objects/scatter/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scatter/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scatter/marker/colorbar/_tickformatstop.py index 767df3dea5..c5b99a6d3f 100644 --- a/plotly/graph_objects/scatter/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scatter/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter/marker/colorbar/_title.py b/plotly/graph_objects/scatter/marker/colorbar/_title.py index 0c0080c47d..5b7b5394f2 100644 --- a/plotly/graph_objects/scatter/marker/colorbar/_title.py +++ b/plotly/graph_objects/scatter/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter/marker/colorbar/title/_font.py b/plotly/graph_objects/scatter/marker/colorbar/title/_font.py index 6c38026760..3f21e27350 100644 --- a/plotly/graph_objects/scatter/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scatter/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter/selected/_marker.py b/plotly/graph_objects/scatter/selected/_marker.py index 491dda198e..f4f3d669d4 100644 --- a/plotly/graph_objects/scatter/selected/_marker.py +++ b/plotly/graph_objects/scatter/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter/selected/_textfont.py b/plotly/graph_objects/scatter/selected/_textfont.py index 225caa3cda..9a022b4076 100644 --- a/plotly/graph_objects/scatter/selected/_textfont.py +++ b/plotly/graph_objects/scatter/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatter/unselected/_marker.py b/plotly/graph_objects/scatter/unselected/_marker.py index 9006c9959b..94566338c4 100644 --- a/plotly/graph_objects/scatter/unselected/_marker.py +++ b/plotly/graph_objects/scatter/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter/unselected/_textfont.py b/plotly/graph_objects/scatter/unselected/_textfont.py index 2c3abef2e8..0fdb83ff50 100644 --- a/plotly/graph_objects/scatter/unselected/_textfont.py +++ b/plotly/graph_objects/scatter/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatter3d/_error_x.py b/plotly/graph_objects/scatter3d/_error_x.py index 512d1b366e..1661153b31 100644 --- a/plotly/graph_objects/scatter3d/_error_x.py +++ b/plotly/graph_objects/scatter3d/_error_x.py @@ -108,11 +108,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -166,7 +167,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -182,7 +184,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -199,7 +202,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -224,8 +228,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -245,7 +251,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -266,7 +273,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,7 +311,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter3d/_error_y.py b/plotly/graph_objects/scatter3d/_error_y.py index ccf816e0fd..f120c65830 100644 --- a/plotly/graph_objects/scatter3d/_error_y.py +++ b/plotly/graph_objects/scatter3d/_error_y.py @@ -108,11 +108,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -166,7 +167,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -182,7 +184,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -199,7 +202,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -224,8 +228,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -245,7 +251,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -266,7 +273,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,7 +311,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter3d/_error_z.py b/plotly/graph_objects/scatter3d/_error_z.py index 669c99f47f..0e322aa5cb 100644 --- a/plotly/graph_objects/scatter3d/_error_z.py +++ b/plotly/graph_objects/scatter3d/_error_z.py @@ -107,11 +107,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -149,7 +150,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -165,7 +167,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -182,7 +185,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -207,8 +211,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -228,7 +234,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -249,7 +256,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -286,7 +294,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter3d/_hoverlabel.py b/plotly/graph_objects/scatter3d/_hoverlabel.py index 405e09f625..8d053d1bfd 100644 --- a/plotly/graph_objects/scatter3d/_hoverlabel.py +++ b/plotly/graph_objects/scatter3d/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scatter3d/_legendgrouptitle.py b/plotly/graph_objects/scatter3d/_legendgrouptitle.py index 60ac847d1f..aab35a9647 100644 --- a/plotly/graph_objects/scatter3d/_legendgrouptitle.py +++ b/plotly/graph_objects/scatter3d/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter3d/_line.py b/plotly/graph_objects/scatter3d/_line.py index bb83cfbb06..c3920d69ee 100644 --- a/plotly/graph_objects/scatter3d/_line.py +++ b/plotly/graph_objects/scatter3d/_line.py @@ -81,7 +81,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatter3d.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scatter3d.line.colorscale + - A list or array of any of the above Returns ------- @@ -196,9 +196,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.line.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.line.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -227,30 +227,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -286,9 +287,10 @@ 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: - ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', - 'solid'] + + - One of the following enumeration values: + + ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', 'solid'] Returns ------- @@ -347,7 +349,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter3d/_marker.py b/plotly/graph_objects/scatter3d/_marker.py index 027960d91e..b621477f36 100644 --- a/plotly/graph_objects/scatter3d/_marker.py +++ b/plotly/graph_objects/scatter3d/_marker.py @@ -89,7 +89,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -112,7 +112,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -134,7 +134,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -155,14 +155,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatter3d.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scatter3d.marker.colorscale + - A list or array of any of the above Returns ------- @@ -204,9 +204,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -235,30 +235,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -293,9 +294,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -317,7 +318,8 @@ def opacity(self): alpha channel. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -376,8 +378,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -397,7 +401,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -417,8 +422,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -439,7 +446,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -475,10 +482,13 @@ 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', 'cross', 'diamond', - 'diamond-open', 'square', 'square-open', 'x'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['circle', 'circle-open', 'cross', 'diamond', 'diamond-open', + 'square', 'square-open', 'x'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatter3d/_projection.py b/plotly/graph_objects/scatter3d/_projection.py index b9829f4972..6ea1267fde 100644 --- a/plotly/graph_objects/scatter3d/_projection.py +++ b/plotly/graph_objects/scatter3d/_projection.py @@ -15,9 +15,9 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.projection.X` - - A dict of string/value properties that will be passed - to the X constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.projection.X` + - A dict of string/value properties that will be passed to the X constructor Returns ------- @@ -34,9 +34,9 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.projection.Y` - - A dict of string/value properties that will be passed - to the Y constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.projection.Y` + - A dict of string/value properties that will be passed to the Y constructor Returns ------- @@ -53,9 +53,9 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.projection.Z` - - A dict of string/value properties that will be passed - to the Z constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.projection.Z` + - A dict of string/value properties that will be passed to the Z constructor Returns ------- diff --git a/plotly/graph_objects/scatter3d/_stream.py b/plotly/graph_objects/scatter3d/_stream.py index f65909f0db..8705dee582 100644 --- a/plotly/graph_objects/scatter3d/_stream.py +++ b/plotly/graph_objects/scatter3d/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scatter3d/_textfont.py b/plotly/graph_objects/scatter3d/_textfont.py index c89348768b..3e1ebff7a0 100644 --- a/plotly/graph_objects/scatter3d/_textfont.py +++ b/plotly/graph_objects/scatter3d/_textfont.py @@ -27,12 +27,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -72,8 +73,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -107,8 +110,10 @@ def familysrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -145,9 +150,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -183,9 +191,12 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -221,7 +232,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatter3d/hoverlabel/_font.py b/plotly/graph_objects/scatter3d/hoverlabel/_font.py index ee69b4c38d..cf24a63795 100644 --- a/plotly/graph_objects/scatter3d/hoverlabel/_font.py +++ b/plotly/graph_objects/scatter3d/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatter3d/legendgrouptitle/_font.py b/plotly/graph_objects/scatter3d/legendgrouptitle/_font.py index d41f7cae0c..200a4db17d 100644 --- a/plotly/graph_objects/scatter3d/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scatter3d/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter3d/line/_colorbar.py b/plotly/graph_objects/scatter3d/line/_colorbar.py index b25e8fbb01..4bcca42bd3 100644 --- a/plotly/graph_objects/scatter3d/line/_colorbar.py +++ b/plotly/graph_objects/scatter3d/line/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scatter3d.line.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scatter3d.line.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scatter3d/line/colorbar/_tickfont.py b/plotly/graph_objects/scatter3d/line/colorbar/_tickfont.py index 4ecfb4a431..9d70bbb820 100644 --- a/plotly/graph_objects/scatter3d/line/colorbar/_tickfont.py +++ b/plotly/graph_objects/scatter3d/line/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter3d/line/colorbar/_tickformatstop.py b/plotly/graph_objects/scatter3d/line/colorbar/_tickformatstop.py index d494b2e35c..82a80a4640 100644 --- a/plotly/graph_objects/scatter3d/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scatter3d/line/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter3d/line/colorbar/_title.py b/plotly/graph_objects/scatter3d/line/colorbar/_title.py index 801a1fd469..a62a9acd59 100644 --- a/plotly/graph_objects/scatter3d/line/colorbar/_title.py +++ b/plotly/graph_objects/scatter3d/line/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.line.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter3d/line/colorbar/title/_font.py b/plotly/graph_objects/scatter3d/line/colorbar/title/_font.py index 22b2b16299..dc9240f4ba 100644 --- a/plotly/graph_objects/scatter3d/line/colorbar/title/_font.py +++ b/plotly/graph_objects/scatter3d/line/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter3d/marker/_colorbar.py b/plotly/graph_objects/scatter3d/marker/_colorbar.py index 7aa90273a7..6c5a04d5af 100644 --- a/plotly/graph_objects/scatter3d/marker/_colorbar.py +++ b/plotly/graph_objects/scatter3d/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scatter3d.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scatter3d.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scatter3d/marker/_line.py b/plotly/graph_objects/scatter3d/marker/_line.py index 8eb608d6bc..819323a02e 100644 --- a/plotly/graph_objects/scatter3d/marker/_line.py +++ b/plotly/graph_objects/scatter3d/marker/_line.py @@ -79,7 +79,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -103,7 +103,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -125,7 +125,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -146,14 +146,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatter3d.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -208,30 +208,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -289,7 +290,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatter3d/marker/colorbar/_tickfont.py b/plotly/graph_objects/scatter3d/marker/colorbar/_tickfont.py index 2d44d4343a..75838d9b00 100644 --- a/plotly/graph_objects/scatter3d/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scatter3d/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter3d/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scatter3d/marker/colorbar/_tickformatstop.py index 9facdf48d4..54878fd421 100644 --- a/plotly/graph_objects/scatter3d/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scatter3d/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter3d/marker/colorbar/_title.py b/plotly/graph_objects/scatter3d/marker/colorbar/_title.py index c7c751780b..d9abf03d1c 100644 --- a/plotly/graph_objects/scatter3d/marker/colorbar/_title.py +++ b/plotly/graph_objects/scatter3d/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatter3d.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatter3d/marker/colorbar/title/_font.py b/plotly/graph_objects/scatter3d/marker/colorbar/title/_font.py index 4ef9d0e0d6..4d16ae80e9 100644 --- a/plotly/graph_objects/scatter3d/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scatter3d/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatter3d/projection/_x.py b/plotly/graph_objects/scatter3d/projection/_x.py index cfa3418b68..1de4031743 100644 --- a/plotly/graph_objects/scatter3d/projection/_x.py +++ b/plotly/graph_objects/scatter3d/projection/_x.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -35,7 +36,8 @@ def scale(self): marker points. The 'scale' property is a number and may be specified as: - - An int or float in the interval [0, 10] + + - An int or float in the interval [0, 10] Returns ------- diff --git a/plotly/graph_objects/scatter3d/projection/_y.py b/plotly/graph_objects/scatter3d/projection/_y.py index 3ec090e938..2c54655d06 100644 --- a/plotly/graph_objects/scatter3d/projection/_y.py +++ b/plotly/graph_objects/scatter3d/projection/_y.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -35,7 +36,8 @@ def scale(self): marker points. The 'scale' property is a number and may be specified as: - - An int or float in the interval [0, 10] + + - An int or float in the interval [0, 10] Returns ------- diff --git a/plotly/graph_objects/scatter3d/projection/_z.py b/plotly/graph_objects/scatter3d/projection/_z.py index 24816e39c6..ccf79fee0f 100644 --- a/plotly/graph_objects/scatter3d/projection/_z.py +++ b/plotly/graph_objects/scatter3d/projection/_z.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -35,7 +36,8 @@ def scale(self): marker points. The 'scale' property is a number and may be specified as: - - An int or float in the interval [0, 10] + + - An int or float in the interval [0, 10] Returns ------- diff --git a/plotly/graph_objects/scattercarpet/_hoverlabel.py b/plotly/graph_objects/scattercarpet/_hoverlabel.py index a52ad0784f..a761a854e4 100644 --- a/plotly/graph_objects/scattercarpet/_hoverlabel.py +++ b/plotly/graph_objects/scattercarpet/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scattercarpet/_legendgrouptitle.py b/plotly/graph_objects/scattercarpet/_legendgrouptitle.py index e425c917ff..608fc65378 100644 --- a/plotly/graph_objects/scattercarpet/_legendgrouptitle.py +++ b/plotly/graph_objects/scattercarpet/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattercarpet/_line.py b/plotly/graph_objects/scattercarpet/_line.py index c795a0f173..a7f7ab5e93 100644 --- a/plotly/graph_objects/scattercarpet/_line.py +++ b/plotly/graph_objects/scattercarpet/_line.py @@ -27,8 +27,10 @@ def backoff(self): markers if `marker.angleref` is set to "previous". The 'backoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -64,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -89,10 +92,14 @@ def dash(self): "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.) + + - 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 ------- @@ -112,8 +119,10 @@ def shape(self): 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'] + + - One of the following enumeration values: + + ['linear', 'spline'] Returns ------- @@ -133,7 +142,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -151,7 +161,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattercarpet/_marker.py b/plotly/graph_objects/scattercarpet/_marker.py index 9d459771c3..a18a5ccd29 100644 --- a/plotly/graph_objects/scattercarpet/_marker.py +++ b/plotly/graph_objects/scattercarpet/_marker.py @@ -68,8 +68,10 @@ def angleref(self): "up", angle 0 points toward the top of the screen. The 'angleref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['previous', 'up'] + + - One of the following enumeration values: + + ['previous', 'up'] Returns ------- @@ -156,7 +158,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -179,7 +181,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -201,7 +203,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,14 +224,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattercarpet.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattercarpet.marker.colorscale + - A list or array of any of the above Returns ------- @@ -271,9 +273,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -302,30 +304,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -360,9 +363,9 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.Gradient` - - A dict of string/value properties that will be passed - to the Gradient constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.Gradient` + - A dict of string/value properties that will be passed to the Gradient constructor Returns ------- @@ -379,9 +382,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -400,7 +403,8 @@ def maxdisplayed(self): corresponds to no limit. The 'maxdisplayed' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -418,8 +422,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -496,8 +502,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -517,7 +525,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -537,8 +546,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -559,7 +570,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -598,8 +609,10 @@ def standoff(self): arrowhead marker at it. The 'standoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -638,97 +651,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattercarpet/_selected.py b/plotly/graph_objects/scattercarpet/_selected.py index 36bbd3a30b..ac88743450 100644 --- a/plotly/graph_objects/scattercarpet/_selected.py +++ b/plotly/graph_objects/scattercarpet/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattercarpet/_stream.py b/plotly/graph_objects/scattercarpet/_stream.py index 2cca68669c..6a841e25a9 100644 --- a/plotly/graph_objects/scattercarpet/_stream.py +++ b/plotly/graph_objects/scattercarpet/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scattercarpet/_textfont.py b/plotly/graph_objects/scattercarpet/_textfont.py index 28547c46b0..93ad90f3e0 100644 --- a/plotly/graph_objects/scattercarpet/_textfont.py +++ b/plotly/graph_objects/scattercarpet/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattercarpet/_unselected.py b/plotly/graph_objects/scattercarpet/_unselected.py index c6a965d89a..3ce57213d1 100644 --- a/plotly/graph_objects/scattercarpet/_unselected.py +++ b/plotly/graph_objects/scattercarpet/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattercarpet/hoverlabel/_font.py b/plotly/graph_objects/scattercarpet/hoverlabel/_font.py index 1e3ba8c1f7..4bbc03c520 100644 --- a/plotly/graph_objects/scattercarpet/hoverlabel/_font.py +++ b/plotly/graph_objects/scattercarpet/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattercarpet/legendgrouptitle/_font.py b/plotly/graph_objects/scattercarpet/legendgrouptitle/_font.py index e1c94ceb42..e8f9b312f9 100644 --- a/plotly/graph_objects/scattercarpet/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scattercarpet/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattercarpet/marker/_colorbar.py b/plotly/graph_objects/scattercarpet/marker/_colorbar.py index 9828785860..a2015cca14 100644 --- a/plotly/graph_objects/scattercarpet/marker/_colorbar.py +++ b/plotly/graph_objects/scattercarpet/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scattercarpet.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scattercarpet.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scattercarpet/marker/_gradient.py b/plotly/graph_objects/scattercarpet/marker/_gradient.py index 3c31d6c469..310b65dd50 100644 --- a/plotly/graph_objects/scattercarpet/marker/_gradient.py +++ b/plotly/graph_objects/scattercarpet/marker/_gradient.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,9 +59,12 @@ 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 + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattercarpet/marker/_line.py b/plotly/graph_objects/scattercarpet/marker/_line.py index fb48dae591..b3cb3a5701 100644 --- a/plotly/graph_objects/scattercarpet/marker/_line.py +++ b/plotly/graph_objects/scattercarpet/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattercarpet.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattercarpet/marker/colorbar/_tickfont.py b/plotly/graph_objects/scattercarpet/marker/colorbar/_tickfont.py index defc763fce..dfa6151d26 100644 --- a/plotly/graph_objects/scattercarpet/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scattercarpet/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattercarpet/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scattercarpet/marker/colorbar/_tickformatstop.py index e4e6370a36..83078c97b1 100644 --- a/plotly/graph_objects/scattercarpet/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scattercarpet/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattercarpet/marker/colorbar/_title.py b/plotly/graph_objects/scattercarpet/marker/colorbar/_title.py index 01969ff296..664edb0c59 100644 --- a/plotly/graph_objects/scattercarpet/marker/colorbar/_title.py +++ b/plotly/graph_objects/scattercarpet/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattercarpet.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattercarpet/marker/colorbar/title/_font.py b/plotly/graph_objects/scattercarpet/marker/colorbar/title/_font.py index 7869ea33db..584986e68e 100644 --- a/plotly/graph_objects/scattercarpet/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scattercarpet/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattercarpet/selected/_marker.py b/plotly/graph_objects/scattercarpet/selected/_marker.py index 5074f2eaa1..3fe19679fd 100644 --- a/plotly/graph_objects/scattercarpet/selected/_marker.py +++ b/plotly/graph_objects/scattercarpet/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattercarpet/selected/_textfont.py b/plotly/graph_objects/scattercarpet/selected/_textfont.py index 92b51b3408..d5dff347f7 100644 --- a/plotly/graph_objects/scattercarpet/selected/_textfont.py +++ b/plotly/graph_objects/scattercarpet/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattercarpet/unselected/_marker.py b/plotly/graph_objects/scattercarpet/unselected/_marker.py index 30f7b7f592..f27e864125 100644 --- a/plotly/graph_objects/scattercarpet/unselected/_marker.py +++ b/plotly/graph_objects/scattercarpet/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattercarpet/unselected/_textfont.py b/plotly/graph_objects/scattercarpet/unselected/_textfont.py index 7590202630..536db9eda7 100644 --- a/plotly/graph_objects/scattercarpet/unselected/_textfont.py +++ b/plotly/graph_objects/scattercarpet/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattergeo/_hoverlabel.py b/plotly/graph_objects/scattergeo/_hoverlabel.py index 9ec595b59d..6e473f3da2 100644 --- a/plotly/graph_objects/scattergeo/_hoverlabel.py +++ b/plotly/graph_objects/scattergeo/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scattergeo/_legendgrouptitle.py b/plotly/graph_objects/scattergeo/_legendgrouptitle.py index 9f06e9e234..cbfa9c6907 100644 --- a/plotly/graph_objects/scattergeo/_legendgrouptitle.py +++ b/plotly/graph_objects/scattergeo/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattergeo/_line.py b/plotly/graph_objects/scattergeo/_line.py index 6912d5ec4f..c3a191e21c 100644 --- a/plotly/graph_objects/scattergeo/_line.py +++ b/plotly/graph_objects/scattergeo/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergeo/_marker.py b/plotly/graph_objects/scattergeo/_marker.py index dc72709a09..af4396e713 100644 --- a/plotly/graph_objects/scattergeo/_marker.py +++ b/plotly/graph_objects/scattergeo/_marker.py @@ -69,8 +69,10 @@ def angleref(self): projection. The 'angleref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['previous', 'up', 'north'] + + - One of the following enumeration values: + + ['previous', 'up', 'north'] Returns ------- @@ -157,7 +159,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -180,7 +182,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -202,7 +204,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -223,14 +225,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattergeo.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattergeo.marker.colorscale + - A list or array of any of the above Returns ------- @@ -272,9 +274,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -303,30 +305,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -361,9 +364,9 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.Gradient` - - A dict of string/value properties that will be passed - to the Gradient constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.Gradient` + - A dict of string/value properties that will be passed to the Gradient constructor Returns ------- @@ -380,9 +383,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -400,8 +403,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -478,8 +483,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -499,7 +506,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -519,8 +527,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -541,7 +551,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -580,8 +590,10 @@ def standoff(self): arrowhead marker at it. The 'standoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -620,97 +632,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattergeo/_selected.py b/plotly/graph_objects/scattergeo/_selected.py index 1ec18837bf..ee94739457 100644 --- a/plotly/graph_objects/scattergeo/_selected.py +++ b/plotly/graph_objects/scattergeo/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattergeo/_stream.py b/plotly/graph_objects/scattergeo/_stream.py index 5ee0a2c727..f80576d2cc 100644 --- a/plotly/graph_objects/scattergeo/_stream.py +++ b/plotly/graph_objects/scattergeo/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scattergeo/_textfont.py b/plotly/graph_objects/scattergeo/_textfont.py index 0dbbdf000a..6d2afd96ac 100644 --- a/plotly/graph_objects/scattergeo/_textfont.py +++ b/plotly/graph_objects/scattergeo/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattergeo/_unselected.py b/plotly/graph_objects/scattergeo/_unselected.py index 4c36d81de3..addc8be3e2 100644 --- a/plotly/graph_objects/scattergeo/_unselected.py +++ b/plotly/graph_objects/scattergeo/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattergeo/hoverlabel/_font.py b/plotly/graph_objects/scattergeo/hoverlabel/_font.py index cb9693d4b4..a90ca37b4d 100644 --- a/plotly/graph_objects/scattergeo/hoverlabel/_font.py +++ b/plotly/graph_objects/scattergeo/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattergeo/legendgrouptitle/_font.py b/plotly/graph_objects/scattergeo/legendgrouptitle/_font.py index 6d49636283..a55a8a5879 100644 --- a/plotly/graph_objects/scattergeo/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scattergeo/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattergeo/marker/_colorbar.py b/plotly/graph_objects/scattergeo/marker/_colorbar.py index b79af22189..a12ab5cb6e 100644 --- a/plotly/graph_objects/scattergeo/marker/_colorbar.py +++ b/plotly/graph_objects/scattergeo/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scattergeo.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scattergeo.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scattergeo/marker/_gradient.py b/plotly/graph_objects/scattergeo/marker/_gradient.py index e59e73802d..36ccf4f7b1 100644 --- a/plotly/graph_objects/scattergeo/marker/_gradient.py +++ b/plotly/graph_objects/scattergeo/marker/_gradient.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,9 +59,12 @@ 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 + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattergeo/marker/_line.py b/plotly/graph_objects/scattergeo/marker/_line.py index 8dce2ccc8d..0a547e8c08 100644 --- a/plotly/graph_objects/scattergeo/marker/_line.py +++ b/plotly/graph_objects/scattergeo/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattergeo.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattergeo/marker/colorbar/_tickfont.py b/plotly/graph_objects/scattergeo/marker/colorbar/_tickfont.py index eea0450f45..d9b16ac7b2 100644 --- a/plotly/graph_objects/scattergeo/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scattergeo/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattergeo/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scattergeo/marker/colorbar/_tickformatstop.py index a9211fa30d..9e9e867153 100644 --- a/plotly/graph_objects/scattergeo/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scattergeo/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattergeo/marker/colorbar/_title.py b/plotly/graph_objects/scattergeo/marker/colorbar/_title.py index cdd04bfe19..4b61ab50d9 100644 --- a/plotly/graph_objects/scattergeo/marker/colorbar/_title.py +++ b/plotly/graph_objects/scattergeo/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattergeo.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattergeo/marker/colorbar/title/_font.py b/plotly/graph_objects/scattergeo/marker/colorbar/title/_font.py index fa7023ab15..8e510897de 100644 --- a/plotly/graph_objects/scattergeo/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scattergeo/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattergeo/selected/_marker.py b/plotly/graph_objects/scattergeo/selected/_marker.py index fee146e7d9..6f0e5c8cee 100644 --- a/plotly/graph_objects/scattergeo/selected/_marker.py +++ b/plotly/graph_objects/scattergeo/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergeo/selected/_textfont.py b/plotly/graph_objects/scattergeo/selected/_textfont.py index 11fcea24e7..c9e5306f3d 100644 --- a/plotly/graph_objects/scattergeo/selected/_textfont.py +++ b/plotly/graph_objects/scattergeo/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattergeo/unselected/_marker.py b/plotly/graph_objects/scattergeo/unselected/_marker.py index f69829bdc4..da20c7617d 100644 --- a/plotly/graph_objects/scattergeo/unselected/_marker.py +++ b/plotly/graph_objects/scattergeo/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergeo/unselected/_textfont.py b/plotly/graph_objects/scattergeo/unselected/_textfont.py index 2f950f7fde..c71e95726c 100644 --- a/plotly/graph_objects/scattergeo/unselected/_textfont.py +++ b/plotly/graph_objects/scattergeo/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattergl/_error_x.py b/plotly/graph_objects/scattergl/_error_x.py index aa896bbe86..563873fc8a 100644 --- a/plotly/graph_objects/scattergl/_error_x.py +++ b/plotly/graph_objects/scattergl/_error_x.py @@ -108,11 +108,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -166,7 +167,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -182,7 +184,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -199,7 +202,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -224,8 +228,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -245,7 +251,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -266,7 +273,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,7 +311,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergl/_error_y.py b/plotly/graph_objects/scattergl/_error_y.py index cb5dcb7835..15a7b1950b 100644 --- a/plotly/graph_objects/scattergl/_error_y.py +++ b/plotly/graph_objects/scattergl/_error_y.py @@ -107,11 +107,12 @@ def color(self): Sets the stroke 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -149,7 +150,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -165,7 +167,8 @@ def thickness(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -182,7 +185,8 @@ def traceref(self, val): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -207,8 +211,10 @@ def type(self): data set `array`. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['percent', 'constant', 'sqrt', 'data'] + + - One of the following enumeration values: + + ['percent', 'constant', 'sqrt', 'data'] Returns ------- @@ -228,7 +234,8 @@ def value(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -249,7 +256,8 @@ def valueminus(self): (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] + + - An int or float in the interval [0, inf] Returns ------- @@ -286,7 +294,8 @@ def width(self): error bars. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergl/_hoverlabel.py b/plotly/graph_objects/scattergl/_hoverlabel.py index ff821e1b38..5f1deee59d 100644 --- a/plotly/graph_objects/scattergl/_hoverlabel.py +++ b/plotly/graph_objects/scattergl/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattergl.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scattergl/_legendgrouptitle.py b/plotly/graph_objects/scattergl/_legendgrouptitle.py index 9562485eb9..f732218bd5 100644 --- a/plotly/graph_objects/scattergl/_legendgrouptitle.py +++ b/plotly/graph_objects/scattergl/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattergl.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattergl/_line.py b/plotly/graph_objects/scattergl/_line.py index 04d5f4cc33..e94f4ef791 100644 --- a/plotly/graph_objects/scattergl/_line.py +++ b/plotly/graph_objects/scattergl/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,9 +39,10 @@ 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: - ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', - 'solid'] + + - One of the following enumeration values: + + ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', 'solid'] Returns ------- @@ -59,8 +61,10 @@ def shape(self): line shapes. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'hv', 'vh', 'hvh', 'vhv'] + + - One of the following enumeration values: + + ['linear', 'hv', 'vh', 'hvh', 'vhv'] Returns ------- @@ -78,7 +82,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergl/_marker.py b/plotly/graph_objects/scattergl/_marker.py index 42d2fec25c..81bd856aaa 100644 --- a/plotly/graph_objects/scattergl/_marker.py +++ b/plotly/graph_objects/scattergl/_marker.py @@ -130,7 +130,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -153,7 +153,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -175,7 +175,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -196,14 +196,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattergl.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattergl.marker.colorscale + - A list or array of any of the above Returns ------- @@ -245,9 +245,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scattergl.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -276,30 +276,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -334,9 +335,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattergl.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -354,8 +355,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -432,8 +435,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -453,7 +458,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +479,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -495,7 +503,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -534,97 +542,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattergl/_selected.py b/plotly/graph_objects/scattergl/_selected.py index 19e54580ce..2d21eb371f 100644 --- a/plotly/graph_objects/scattergl/_selected.py +++ b/plotly/graph_objects/scattergl/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattergl.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattergl.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattergl/_stream.py b/plotly/graph_objects/scattergl/_stream.py index f7b7c8288e..2cfa6da67b 100644 --- a/plotly/graph_objects/scattergl/_stream.py +++ b/plotly/graph_objects/scattergl/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scattergl/_textfont.py b/plotly/graph_objects/scattergl/_textfont.py index ef7a9e6f96..2c0b2a3c25 100644 --- a/plotly/graph_objects/scattergl/_textfont.py +++ b/plotly/graph_objects/scattergl/_textfont.py @@ -27,12 +27,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -72,8 +73,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -107,8 +110,10 @@ def familysrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -145,9 +150,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -183,9 +191,12 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -221,9 +232,12 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'bold'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'bold'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattergl/_unselected.py b/plotly/graph_objects/scattergl/_unselected.py index 69fe5cb1bd..6f17e45c7b 100644 --- a/plotly/graph_objects/scattergl/_unselected.py +++ b/plotly/graph_objects/scattergl/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattergl.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattergl.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattergl/hoverlabel/_font.py b/plotly/graph_objects/scattergl/hoverlabel/_font.py index 6b4b2663bd..51dc463a12 100644 --- a/plotly/graph_objects/scattergl/hoverlabel/_font.py +++ b/plotly/graph_objects/scattergl/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattergl/legendgrouptitle/_font.py b/plotly/graph_objects/scattergl/legendgrouptitle/_font.py index 31234fa14b..fcdf13a16e 100644 --- a/plotly/graph_objects/scattergl/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scattergl/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattergl/marker/_colorbar.py b/plotly/graph_objects/scattergl/marker/_colorbar.py index 63bd7b391e..94b2e2fdbf 100644 --- a/plotly/graph_objects/scattergl/marker/_colorbar.py +++ b/plotly/graph_objects/scattergl/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scattergl.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scattergl.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scattergl/marker/_line.py b/plotly/graph_objects/scattergl/marker/_line.py index 860117b1e3..35cb6f4b0d 100644 --- a/plotly/graph_objects/scattergl/marker/_line.py +++ b/plotly/graph_objects/scattergl/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattergl.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattergl/marker/colorbar/_tickfont.py b/plotly/graph_objects/scattergl/marker/colorbar/_tickfont.py index ddb75a3b2e..b005b38bd6 100644 --- a/plotly/graph_objects/scattergl/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scattergl/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattergl/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scattergl/marker/colorbar/_tickformatstop.py index 1cbcf0411d..f5b5cbaba4 100644 --- a/plotly/graph_objects/scattergl/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scattergl/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattergl/marker/colorbar/_title.py b/plotly/graph_objects/scattergl/marker/colorbar/_title.py index d5abc2a31a..296f32d335 100644 --- a/plotly/graph_objects/scattergl/marker/colorbar/_title.py +++ b/plotly/graph_objects/scattergl/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattergl.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattergl/marker/colorbar/title/_font.py b/plotly/graph_objects/scattergl/marker/colorbar/title/_font.py index 85615cc3fd..e79d9c077f 100644 --- a/plotly/graph_objects/scattergl/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scattergl/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattergl/selected/_marker.py b/plotly/graph_objects/scattergl/selected/_marker.py index 0520a7c676..3fca5c6cc5 100644 --- a/plotly/graph_objects/scattergl/selected/_marker.py +++ b/plotly/graph_objects/scattergl/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergl/selected/_textfont.py b/plotly/graph_objects/scattergl/selected/_textfont.py index d4965adb65..3e89dedee4 100644 --- a/plotly/graph_objects/scattergl/selected/_textfont.py +++ b/plotly/graph_objects/scattergl/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattergl/unselected/_marker.py b/plotly/graph_objects/scattergl/unselected/_marker.py index 5804ad1c8e..48f5f089d6 100644 --- a/plotly/graph_objects/scattergl/unselected/_marker.py +++ b/plotly/graph_objects/scattergl/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattergl/unselected/_textfont.py b/plotly/graph_objects/scattergl/unselected/_textfont.py index 4b5b6af3ff..a7b7cb7324 100644 --- a/plotly/graph_objects/scattergl/unselected/_textfont.py +++ b/plotly/graph_objects/scattergl/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattermap/_cluster.py b/plotly/graph_objects/scattermap/_cluster.py index 7200c60d00..316e908b0b 100644 --- a/plotly/graph_objects/scattermap/_cluster.py +++ b/plotly/graph_objects/scattermap/_cluster.py @@ -27,12 +27,13 @@ def color(self): Sets the color for each cluster step. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -87,7 +88,8 @@ def maxzoom(self): than this, points will never be clustered. The 'maxzoom' property is a number and may be specified as: - - An int or float in the interval [0, 24] + + - An int or float in the interval [0, 24] Returns ------- @@ -105,8 +107,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -142,8 +146,10 @@ def size(self): Sets the size for each cluster step. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -183,8 +189,10 @@ def step(self): the given value until one less than the next value. The 'step' 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 + + - An int or float in the interval [-1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattermap/_hoverlabel.py b/plotly/graph_objects/scattermap/_hoverlabel.py index d64862a300..8c9d6f4f22 100644 --- a/plotly/graph_objects/scattermap/_hoverlabel.py +++ b/plotly/graph_objects/scattermap/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattermap.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scattermap/_legendgrouptitle.py b/plotly/graph_objects/scattermap/_legendgrouptitle.py index 97acc35b5e..1911a9876e 100644 --- a/plotly/graph_objects/scattermap/_legendgrouptitle.py +++ b/plotly/graph_objects/scattermap/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattermap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattermap/_line.py b/plotly/graph_objects/scattermap/_line.py index ec077479a6..b5bceb691b 100644 --- a/plotly/graph_objects/scattermap/_line.py +++ b/plotly/graph_objects/scattermap/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattermap/_marker.py b/plotly/graph_objects/scattermap/_marker.py index e9c22399dd..7a0d81a62d 100644 --- a/plotly/graph_objects/scattermap/_marker.py +++ b/plotly/graph_objects/scattermap/_marker.py @@ -63,8 +63,9 @@ def angle(self): The 'angle' property is a number and may be specified as: - - An int or float - - A tuple, list, or one-dimensional numpy array of the above + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -151,7 +152,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -174,7 +175,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -196,7 +197,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -217,14 +218,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattermap.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattermap.marker.colorscale + - A list or array of any of the above Returns ------- @@ -266,9 +267,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scattermap.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -297,30 +298,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -356,8 +358,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -434,8 +438,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -455,7 +461,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -475,8 +482,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -497,7 +506,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -535,9 +544,12 @@ def symbol(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattermap/_selected.py b/plotly/graph_objects/scattermap/_selected.py index 71970ef4c3..7a6b435b9b 100644 --- a/plotly/graph_objects/scattermap/_selected.py +++ b/plotly/graph_objects/scattermap/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattermap.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/scattermap/_stream.py b/plotly/graph_objects/scattermap/_stream.py index a0cec7326d..f16c5f9351 100644 --- a/plotly/graph_objects/scattermap/_stream.py +++ b/plotly/graph_objects/scattermap/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scattermap/_textfont.py b/plotly/graph_objects/scattermap/_textfont.py index 9de007a9ce..c936a74386 100644 --- a/plotly/graph_objects/scattermap/_textfont.py +++ b/plotly/graph_objects/scattermap/_textfont.py @@ -14,11 +14,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -56,7 +58,8 @@ def family(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -75,8 +78,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -94,7 +99,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermap/_unselected.py b/plotly/graph_objects/scattermap/_unselected.py index 0ffe3fedf6..4441e9d69c 100644 --- a/plotly/graph_objects/scattermap/_unselected.py +++ b/plotly/graph_objects/scattermap/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattermap.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/scattermap/hoverlabel/_font.py b/plotly/graph_objects/scattermap/hoverlabel/_font.py index efc1d6b996..dda5fb7326 100644 --- a/plotly/graph_objects/scattermap/hoverlabel/_font.py +++ b/plotly/graph_objects/scattermap/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattermap/legendgrouptitle/_font.py b/plotly/graph_objects/scattermap/legendgrouptitle/_font.py index 41fc96f955..062f69edcd 100644 --- a/plotly/graph_objects/scattermap/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scattermap/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermap/marker/_colorbar.py b/plotly/graph_objects/scattermap/marker/_colorbar.py index dcb9b28dba..c711f7c334 100644 --- a/plotly/graph_objects/scattermap/marker/_colorbar.py +++ b/plotly/graph_objects/scattermap/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scattermap.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scattermap.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scattermap/marker/colorbar/_tickfont.py b/plotly/graph_objects/scattermap/marker/colorbar/_tickfont.py index 0cded3b853..012292374b 100644 --- a/plotly/graph_objects/scattermap/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scattermap/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermap/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scattermap/marker/colorbar/_tickformatstop.py index ac029e00af..c2fa691420 100644 --- a/plotly/graph_objects/scattermap/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scattermap/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattermap/marker/colorbar/_title.py b/plotly/graph_objects/scattermap/marker/colorbar/_title.py index b8f4b534e9..4e87c3782a 100644 --- a/plotly/graph_objects/scattermap/marker/colorbar/_title.py +++ b/plotly/graph_objects/scattermap/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattermap.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattermap/marker/colorbar/title/_font.py b/plotly/graph_objects/scattermap/marker/colorbar/title/_font.py index 407fa222ed..65b9add0fe 100644 --- a/plotly/graph_objects/scattermap/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scattermap/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermap/selected/_marker.py b/plotly/graph_objects/scattermap/selected/_marker.py index 3070e627f2..a9d780488f 100644 --- a/plotly/graph_objects/scattermap/selected/_marker.py +++ b/plotly/graph_objects/scattermap/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattermap/unselected/_marker.py b/plotly/graph_objects/scattermap/unselected/_marker.py index d73184abfa..4a3fb8ed08 100644 --- a/plotly/graph_objects/scattermap/unselected/_marker.py +++ b/plotly/graph_objects/scattermap/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_cluster.py b/plotly/graph_objects/scattermapbox/_cluster.py index f9226956d8..d1e58f023e 100644 --- a/plotly/graph_objects/scattermapbox/_cluster.py +++ b/plotly/graph_objects/scattermapbox/_cluster.py @@ -27,12 +27,13 @@ def color(self): Sets the color for each cluster step. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -87,7 +88,8 @@ def maxzoom(self): than this, points will never be clustered. The 'maxzoom' property is a number and may be specified as: - - An int or float in the interval [0, 24] + + - An int or float in the interval [0, 24] Returns ------- @@ -105,8 +107,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -142,8 +146,10 @@ def size(self): Sets the size for each cluster step. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -183,8 +189,10 @@ def step(self): the given value until one less than the next value. The 'step' 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 + + - An int or float in the interval [-1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_hoverlabel.py b/plotly/graph_objects/scattermapbox/_hoverlabel.py index d87bc58579..67c2253bf1 100644 --- a/plotly/graph_objects/scattermapbox/_hoverlabel.py +++ b/plotly/graph_objects/scattermapbox/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scattermapbox/_legendgrouptitle.py b/plotly/graph_objects/scattermapbox/_legendgrouptitle.py index 178c91e7d7..19c61f48e7 100644 --- a/plotly/graph_objects/scattermapbox/_legendgrouptitle.py +++ b/plotly/graph_objects/scattermapbox/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_line.py b/plotly/graph_objects/scattermapbox/_line.py index ffec50f690..01d5d230b2 100644 --- a/plotly/graph_objects/scattermapbox/_line.py +++ b/plotly/graph_objects/scattermapbox/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_marker.py b/plotly/graph_objects/scattermapbox/_marker.py index 74dc6a0b31..e8c388cafd 100644 --- a/plotly/graph_objects/scattermapbox/_marker.py +++ b/plotly/graph_objects/scattermapbox/_marker.py @@ -63,8 +63,9 @@ def angle(self): The 'angle' property is a number and may be specified as: - - An int or float - - A tuple, list, or one-dimensional numpy array of the above + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -151,7 +152,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -174,7 +175,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -196,7 +197,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -217,14 +218,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattermapbox.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattermapbox.marker.colorscale + - A list or array of any of the above Returns ------- @@ -266,9 +267,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -297,30 +298,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -356,8 +358,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -434,8 +438,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -455,7 +461,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -475,8 +482,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -497,7 +506,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -535,9 +544,12 @@ def symbol(self): 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_selected.py b/plotly/graph_objects/scattermapbox/_selected.py index 0e204dab8f..eed417f948 100644 --- a/plotly/graph_objects/scattermapbox/_selected.py +++ b/plotly/graph_objects/scattermapbox/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_stream.py b/plotly/graph_objects/scattermapbox/_stream.py index b2257054c4..c8d80bc3e8 100644 --- a/plotly/graph_objects/scattermapbox/_stream.py +++ b/plotly/graph_objects/scattermapbox/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scattermapbox/_textfont.py b/plotly/graph_objects/scattermapbox/_textfont.py index 86f83e8c55..7ace51db11 100644 --- a/plotly/graph_objects/scattermapbox/_textfont.py +++ b/plotly/graph_objects/scattermapbox/_textfont.py @@ -14,11 +14,12 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -56,7 +58,8 @@ def family(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -75,8 +78,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -94,7 +99,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermapbox/_unselected.py b/plotly/graph_objects/scattermapbox/_unselected.py index b08bce0ddf..17b23c821a 100644 --- a/plotly/graph_objects/scattermapbox/_unselected.py +++ b/plotly/graph_objects/scattermapbox/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/scattermapbox/hoverlabel/_font.py b/plotly/graph_objects/scattermapbox/hoverlabel/_font.py index a63bd4804c..394599c1de 100644 --- a/plotly/graph_objects/scattermapbox/hoverlabel/_font.py +++ b/plotly/graph_objects/scattermapbox/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattermapbox/legendgrouptitle/_font.py b/plotly/graph_objects/scattermapbox/legendgrouptitle/_font.py index fddcc48e8a..55e9074f1b 100644 --- a/plotly/graph_objects/scattermapbox/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scattermapbox/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermapbox/marker/_colorbar.py b/plotly/graph_objects/scattermapbox/marker/_colorbar.py index a1b80377e6..89172aaeab 100644 --- a/plotly/graph_objects/scattermapbox/marker/_colorbar.py +++ b/plotly/graph_objects/scattermapbox/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scattermapbox.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scattermapbox.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scattermapbox/marker/colorbar/_tickfont.py b/plotly/graph_objects/scattermapbox/marker/colorbar/_tickfont.py index 1918e1e479..d717fe5281 100644 --- a/plotly/graph_objects/scattermapbox/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scattermapbox/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermapbox/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scattermapbox/marker/colorbar/_tickformatstop.py index ef081d313d..444ccea36d 100644 --- a/plotly/graph_objects/scattermapbox/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scattermapbox/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattermapbox/marker/colorbar/_title.py b/plotly/graph_objects/scattermapbox/marker/colorbar/_title.py index 6c1f4612ff..5d3b6b43df 100644 --- a/plotly/graph_objects/scattermapbox/marker/colorbar/_title.py +++ b/plotly/graph_objects/scattermapbox/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattermapbox.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattermapbox/marker/colorbar/title/_font.py b/plotly/graph_objects/scattermapbox/marker/colorbar/title/_font.py index 7f963cd61d..74e63c61ed 100644 --- a/plotly/graph_objects/scattermapbox/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scattermapbox/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattermapbox/selected/_marker.py b/plotly/graph_objects/scattermapbox/selected/_marker.py index 8201e6c0cd..f3198e1146 100644 --- a/plotly/graph_objects/scattermapbox/selected/_marker.py +++ b/plotly/graph_objects/scattermapbox/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattermapbox/unselected/_marker.py b/plotly/graph_objects/scattermapbox/unselected/_marker.py index c65b0c9883..ea69efd057 100644 --- a/plotly/graph_objects/scattermapbox/unselected/_marker.py +++ b/plotly/graph_objects/scattermapbox/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolar/_hoverlabel.py b/plotly/graph_objects/scatterpolar/_hoverlabel.py index 26e06bcb17..f8e417dc54 100644 --- a/plotly/graph_objects/scatterpolar/_hoverlabel.py +++ b/plotly/graph_objects/scatterpolar/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scatterpolar/_legendgrouptitle.py b/plotly/graph_objects/scatterpolar/_legendgrouptitle.py index fd32f71903..4461696576 100644 --- a/plotly/graph_objects/scatterpolar/_legendgrouptitle.py +++ b/plotly/graph_objects/scatterpolar/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterpolar/_line.py b/plotly/graph_objects/scatterpolar/_line.py index 1949c58e6a..d7ebce92c1 100644 --- a/plotly/graph_objects/scatterpolar/_line.py +++ b/plotly/graph_objects/scatterpolar/_line.py @@ -27,8 +27,10 @@ def backoff(self): markers if `marker.angleref` is set to "previous". The 'backoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -64,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -89,10 +92,14 @@ def dash(self): "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.) + + - 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 ------- @@ -112,8 +119,10 @@ def shape(self): 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'] + + - One of the following enumeration values: + + ['linear', 'spline'] Returns ------- @@ -133,7 +142,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -151,7 +161,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolar/_marker.py b/plotly/graph_objects/scatterpolar/_marker.py index e7dafe0a4a..46e5ed43ac 100644 --- a/plotly/graph_objects/scatterpolar/_marker.py +++ b/plotly/graph_objects/scatterpolar/_marker.py @@ -68,8 +68,10 @@ def angleref(self): "up", angle 0 points toward the top of the screen. The 'angleref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['previous', 'up'] + + - One of the following enumeration values: + + ['previous', 'up'] Returns ------- @@ -156,7 +158,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -179,7 +181,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -201,7 +203,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,14 +224,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatterpolar.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scatterpolar.marker.colorscale + - A list or array of any of the above Returns ------- @@ -271,9 +273,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -302,30 +304,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -360,9 +363,9 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.Gradient` - - A dict of string/value properties that will be passed - to the Gradient constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.Gradient` + - A dict of string/value properties that will be passed to the Gradient constructor Returns ------- @@ -379,9 +382,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -400,7 +403,8 @@ def maxdisplayed(self): corresponds to no limit. The 'maxdisplayed' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -418,8 +422,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -496,8 +502,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -517,7 +525,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -537,8 +546,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -559,7 +570,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -598,8 +609,10 @@ def standoff(self): arrowhead marker at it. The 'standoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -638,97 +651,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterpolar/_selected.py b/plotly/graph_objects/scatterpolar/_selected.py index 919fd075de..e5125dd646 100644 --- a/plotly/graph_objects/scatterpolar/_selected.py +++ b/plotly/graph_objects/scatterpolar/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatterpolar/_stream.py b/plotly/graph_objects/scatterpolar/_stream.py index 4258e6ac08..9bcf1da429 100644 --- a/plotly/graph_objects/scatterpolar/_stream.py +++ b/plotly/graph_objects/scatterpolar/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scatterpolar/_textfont.py b/plotly/graph_objects/scatterpolar/_textfont.py index 3a5cbc4810..0dba5ca48e 100644 --- a/plotly/graph_objects/scatterpolar/_textfont.py +++ b/plotly/graph_objects/scatterpolar/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatterpolar/_unselected.py b/plotly/graph_objects/scatterpolar/_unselected.py index 770c201291..594e797d91 100644 --- a/plotly/graph_objects/scatterpolar/_unselected.py +++ b/plotly/graph_objects/scatterpolar/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatterpolar/hoverlabel/_font.py b/plotly/graph_objects/scatterpolar/hoverlabel/_font.py index df1021c1fa..ee4c886915 100644 --- a/plotly/graph_objects/scatterpolar/hoverlabel/_font.py +++ b/plotly/graph_objects/scatterpolar/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatterpolar/legendgrouptitle/_font.py b/plotly/graph_objects/scatterpolar/legendgrouptitle/_font.py index 471f64421c..8530fba888 100644 --- a/plotly/graph_objects/scatterpolar/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scatterpolar/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterpolar/marker/_colorbar.py b/plotly/graph_objects/scatterpolar/marker/_colorbar.py index 29c6f3c65c..7cc4869316 100644 --- a/plotly/graph_objects/scatterpolar/marker/_colorbar.py +++ b/plotly/graph_objects/scatterpolar/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scatterpolar.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scatterpolar.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scatterpolar/marker/_gradient.py b/plotly/graph_objects/scatterpolar/marker/_gradient.py index c00290a599..6b30a0bd40 100644 --- a/plotly/graph_objects/scatterpolar/marker/_gradient.py +++ b/plotly/graph_objects/scatterpolar/marker/_gradient.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,9 +59,12 @@ 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 + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterpolar/marker/_line.py b/plotly/graph_objects/scatterpolar/marker/_line.py index 4c7c6d45c9..43d4f55fba 100644 --- a/plotly/graph_objects/scatterpolar/marker/_line.py +++ b/plotly/graph_objects/scatterpolar/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatterpolar.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterpolar/marker/colorbar/_tickfont.py b/plotly/graph_objects/scatterpolar/marker/colorbar/_tickfont.py index b756b3107b..919a0643d0 100644 --- a/plotly/graph_objects/scatterpolar/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scatterpolar/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scatterpolar/marker/colorbar/_tickformatstop.py index d8221e63c1..d5bb51a6f4 100644 --- a/plotly/graph_objects/scatterpolar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scatterpolar/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterpolar/marker/colorbar/_title.py b/plotly/graph_objects/scatterpolar/marker/colorbar/_title.py index 6d513eea1d..ec2e825cd2 100644 --- a/plotly/graph_objects/scatterpolar/marker/colorbar/_title.py +++ b/plotly/graph_objects/scatterpolar/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterpolar.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterpolar/marker/colorbar/title/_font.py b/plotly/graph_objects/scatterpolar/marker/colorbar/title/_font.py index 4d2a1f29bc..52e6ad7a6a 100644 --- a/plotly/graph_objects/scatterpolar/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scatterpolar/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterpolar/selected/_marker.py b/plotly/graph_objects/scatterpolar/selected/_marker.py index ecfed7fc56..536db525ad 100644 --- a/plotly/graph_objects/scatterpolar/selected/_marker.py +++ b/plotly/graph_objects/scatterpolar/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolar/selected/_textfont.py b/plotly/graph_objects/scatterpolar/selected/_textfont.py index fe59dd4e25..09db14ce63 100644 --- a/plotly/graph_objects/scatterpolar/selected/_textfont.py +++ b/plotly/graph_objects/scatterpolar/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatterpolar/unselected/_marker.py b/plotly/graph_objects/scatterpolar/unselected/_marker.py index 91b7c6847c..48c285584d 100644 --- a/plotly/graph_objects/scatterpolar/unselected/_marker.py +++ b/plotly/graph_objects/scatterpolar/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolar/unselected/_textfont.py b/plotly/graph_objects/scatterpolar/unselected/_textfont.py index fff1df8a41..5ab77563d0 100644 --- a/plotly/graph_objects/scatterpolar/unselected/_textfont.py +++ b/plotly/graph_objects/scatterpolar/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_hoverlabel.py b/plotly/graph_objects/scatterpolargl/_hoverlabel.py index c825f3a0e0..36ebfed868 100644 --- a/plotly/graph_objects/scatterpolargl/_hoverlabel.py +++ b/plotly/graph_objects/scatterpolargl/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scatterpolargl/_legendgrouptitle.py b/plotly/graph_objects/scatterpolargl/_legendgrouptitle.py index 2c1e2677ab..ef8298fa90 100644 --- a/plotly/graph_objects/scatterpolargl/_legendgrouptitle.py +++ b/plotly/graph_objects/scatterpolargl/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_line.py b/plotly/graph_objects/scatterpolargl/_line.py index 9f4c16db25..f0fa16949d 100644 --- a/plotly/graph_objects/scatterpolargl/_line.py +++ b/plotly/graph_objects/scatterpolargl/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,9 +39,10 @@ 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: - ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', - 'solid'] + + - One of the following enumeration values: + + ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', 'solid'] Returns ------- @@ -58,7 +60,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_marker.py b/plotly/graph_objects/scatterpolargl/_marker.py index 7fd5a0fe1e..a7e0257ff3 100644 --- a/plotly/graph_objects/scatterpolargl/_marker.py +++ b/plotly/graph_objects/scatterpolargl/_marker.py @@ -130,7 +130,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -153,7 +153,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -175,7 +175,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -196,14 +196,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatterpolargl.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scatterpolargl.marker.colorscale + - A list or array of any of the above Returns ------- @@ -245,9 +245,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -276,30 +276,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -334,9 +335,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -354,8 +355,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -432,8 +435,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -453,7 +458,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +479,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -495,7 +503,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -534,97 +542,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_selected.py b/plotly/graph_objects/scatterpolargl/_selected.py index bff3960e0b..bc1e7202e0 100644 --- a/plotly/graph_objects/scatterpolargl/_selected.py +++ b/plotly/graph_objects/scatterpolargl/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_stream.py b/plotly/graph_objects/scatterpolargl/_stream.py index 113df8381c..f36f143129 100644 --- a/plotly/graph_objects/scatterpolargl/_stream.py +++ b/plotly/graph_objects/scatterpolargl/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_textfont.py b/plotly/graph_objects/scatterpolargl/_textfont.py index 4b6b058844..5073e5f054 100644 --- a/plotly/graph_objects/scatterpolargl/_textfont.py +++ b/plotly/graph_objects/scatterpolargl/_textfont.py @@ -27,12 +27,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -72,8 +73,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -107,8 +110,10 @@ def familysrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -145,9 +150,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -183,9 +191,12 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -221,9 +232,12 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'bold'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'bold'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/_unselected.py b/plotly/graph_objects/scatterpolargl/_unselected.py index 3c19d279a5..0e21056cd5 100644 --- a/plotly/graph_objects/scatterpolargl/_unselected.py +++ b/plotly/graph_objects/scatterpolargl/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/hoverlabel/_font.py b/plotly/graph_objects/scatterpolargl/hoverlabel/_font.py index e14e92cfc2..b0ff0137fd 100644 --- a/plotly/graph_objects/scatterpolargl/hoverlabel/_font.py +++ b/plotly/graph_objects/scatterpolargl/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatterpolargl/legendgrouptitle/_font.py b/plotly/graph_objects/scatterpolargl/legendgrouptitle/_font.py index 356f586c37..d8e0791be1 100644 --- a/plotly/graph_objects/scatterpolargl/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scatterpolargl/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterpolargl/marker/_colorbar.py b/plotly/graph_objects/scatterpolargl/marker/_colorbar.py index 5196a5d2f4..df19268c8d 100644 --- a/plotly/graph_objects/scatterpolargl/marker/_colorbar.py +++ b/plotly/graph_objects/scatterpolargl/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scatterpolargl.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scatterpolargl.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/marker/_line.py b/plotly/graph_objects/scatterpolargl/marker/_line.py index 7289f48561..2032bb0017 100644 --- a/plotly/graph_objects/scatterpolargl/marker/_line.py +++ b/plotly/graph_objects/scatterpolargl/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatterpolargl.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickfont.py b/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickfont.py index 00b279d2d6..3af628c1f1 100644 --- a/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickformatstop.py index 2f04fef8c8..ad02c65672 100644 --- a/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scatterpolargl/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/marker/colorbar/_title.py b/plotly/graph_objects/scatterpolargl/marker/colorbar/_title.py index f8c94443b6..eff1af270b 100644 --- a/plotly/graph_objects/scatterpolargl/marker/colorbar/_title.py +++ b/plotly/graph_objects/scatterpolargl/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterpolargl.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/marker/colorbar/title/_font.py b/plotly/graph_objects/scatterpolargl/marker/colorbar/title/_font.py index 5d5d7bad1e..61061e8ce2 100644 --- a/plotly/graph_objects/scatterpolargl/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scatterpolargl/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterpolargl/selected/_marker.py b/plotly/graph_objects/scatterpolargl/selected/_marker.py index 55f0510abb..ee66b05774 100644 --- a/plotly/graph_objects/scatterpolargl/selected/_marker.py +++ b/plotly/graph_objects/scatterpolargl/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/selected/_textfont.py b/plotly/graph_objects/scatterpolargl/selected/_textfont.py index 5ac9f17b3d..149768c9d9 100644 --- a/plotly/graph_objects/scatterpolargl/selected/_textfont.py +++ b/plotly/graph_objects/scatterpolargl/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/unselected/_marker.py b/plotly/graph_objects/scatterpolargl/unselected/_marker.py index 5c679c1f45..d645c10dc8 100644 --- a/plotly/graph_objects/scatterpolargl/unselected/_marker.py +++ b/plotly/graph_objects/scatterpolargl/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterpolargl/unselected/_textfont.py b/plotly/graph_objects/scatterpolargl/unselected/_textfont.py index fd4b9d7c8d..462a0ac3b3 100644 --- a/plotly/graph_objects/scatterpolargl/unselected/_textfont.py +++ b/plotly/graph_objects/scatterpolargl/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattersmith/_hoverlabel.py b/plotly/graph_objects/scattersmith/_hoverlabel.py index 0ea442674f..2c92cff21f 100644 --- a/plotly/graph_objects/scattersmith/_hoverlabel.py +++ b/plotly/graph_objects/scattersmith/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scattersmith/_legendgrouptitle.py b/plotly/graph_objects/scattersmith/_legendgrouptitle.py index 89002fa66a..e902dab169 100644 --- a/plotly/graph_objects/scattersmith/_legendgrouptitle.py +++ b/plotly/graph_objects/scattersmith/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattersmith/_line.py b/plotly/graph_objects/scattersmith/_line.py index 31a8ab51a3..51d8498fb4 100644 --- a/plotly/graph_objects/scattersmith/_line.py +++ b/plotly/graph_objects/scattersmith/_line.py @@ -27,8 +27,10 @@ def backoff(self): markers if `marker.angleref` is set to "previous". The 'backoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -64,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -89,10 +92,14 @@ def dash(self): "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.) + + - 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 ------- @@ -112,8 +119,10 @@ def shape(self): 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'] + + - One of the following enumeration values: + + ['linear', 'spline'] Returns ------- @@ -133,7 +142,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -151,7 +161,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattersmith/_marker.py b/plotly/graph_objects/scattersmith/_marker.py index 8e64a2d79d..2f2056b5a0 100644 --- a/plotly/graph_objects/scattersmith/_marker.py +++ b/plotly/graph_objects/scattersmith/_marker.py @@ -68,8 +68,10 @@ def angleref(self): "up", angle 0 points toward the top of the screen. The 'angleref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['previous', 'up'] + + - One of the following enumeration values: + + ['previous', 'up'] Returns ------- @@ -156,7 +158,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -179,7 +181,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -201,7 +203,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,14 +224,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattersmith.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattersmith.marker.colorscale + - A list or array of any of the above Returns ------- @@ -271,9 +273,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -302,30 +304,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -360,9 +363,9 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.Gradient` - - A dict of string/value properties that will be passed - to the Gradient constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.Gradient` + - A dict of string/value properties that will be passed to the Gradient constructor Returns ------- @@ -379,9 +382,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -400,7 +403,8 @@ def maxdisplayed(self): corresponds to no limit. The 'maxdisplayed' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -418,8 +422,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -496,8 +502,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -517,7 +525,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -537,8 +546,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -559,7 +570,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -598,8 +609,10 @@ def standoff(self): arrowhead marker at it. The 'standoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -638,97 +651,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattersmith/_selected.py b/plotly/graph_objects/scattersmith/_selected.py index 02eed6f105..cdcf9e4829 100644 --- a/plotly/graph_objects/scattersmith/_selected.py +++ b/plotly/graph_objects/scattersmith/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattersmith/_stream.py b/plotly/graph_objects/scattersmith/_stream.py index 3a55e2bdfc..463ccfeff7 100644 --- a/plotly/graph_objects/scattersmith/_stream.py +++ b/plotly/graph_objects/scattersmith/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scattersmith/_textfont.py b/plotly/graph_objects/scattersmith/_textfont.py index 62ab09e468..fa30ad5948 100644 --- a/plotly/graph_objects/scattersmith/_textfont.py +++ b/plotly/graph_objects/scattersmith/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattersmith/_unselected.py b/plotly/graph_objects/scattersmith/_unselected.py index fff36df3f6..2b3664c66a 100644 --- a/plotly/graph_objects/scattersmith/_unselected.py +++ b/plotly/graph_objects/scattersmith/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scattersmith/hoverlabel/_font.py b/plotly/graph_objects/scattersmith/hoverlabel/_font.py index d7f827dabd..5ec7f40782 100644 --- a/plotly/graph_objects/scattersmith/hoverlabel/_font.py +++ b/plotly/graph_objects/scattersmith/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scattersmith/legendgrouptitle/_font.py b/plotly/graph_objects/scattersmith/legendgrouptitle/_font.py index b054fdf4b9..a7456e3e9b 100644 --- a/plotly/graph_objects/scattersmith/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scattersmith/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattersmith/marker/_colorbar.py b/plotly/graph_objects/scattersmith/marker/_colorbar.py index 0e7e75f4c7..999339523d 100644 --- a/plotly/graph_objects/scattersmith/marker/_colorbar.py +++ b/plotly/graph_objects/scattersmith/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scattersmith.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scattersmith.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scattersmith/marker/_gradient.py b/plotly/graph_objects/scattersmith/marker/_gradient.py index 595f2f964d..585c11c9ae 100644 --- a/plotly/graph_objects/scattersmith/marker/_gradient.py +++ b/plotly/graph_objects/scattersmith/marker/_gradient.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,9 +59,12 @@ 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 + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattersmith/marker/_line.py b/plotly/graph_objects/scattersmith/marker/_line.py index 36ced64ec3..8aaf3ad3e6 100644 --- a/plotly/graph_objects/scattersmith/marker/_line.py +++ b/plotly/graph_objects/scattersmith/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scattersmith.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scattersmith.marker.line.colorscale + - A list or array of any of the above Returns ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scattersmith/marker/colorbar/_tickfont.py b/plotly/graph_objects/scattersmith/marker/colorbar/_tickfont.py index 437295a6da..5f95ea3abd 100644 --- a/plotly/graph_objects/scattersmith/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scattersmith/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattersmith/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scattersmith/marker/colorbar/_tickformatstop.py index 139614c36c..dad6317139 100644 --- a/plotly/graph_objects/scattersmith/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scattersmith/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattersmith/marker/colorbar/_title.py b/plotly/graph_objects/scattersmith/marker/colorbar/_title.py index d5dd07fbf3..c3e0f1d06d 100644 --- a/plotly/graph_objects/scattersmith/marker/colorbar/_title.py +++ b/plotly/graph_objects/scattersmith/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scattersmith.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scattersmith/marker/colorbar/title/_font.py b/plotly/graph_objects/scattersmith/marker/colorbar/title/_font.py index 3a47edd4cb..ad56c77928 100644 --- a/plotly/graph_objects/scattersmith/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scattersmith/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scattersmith/selected/_marker.py b/plotly/graph_objects/scattersmith/selected/_marker.py index 61a4852986..500188042d 100644 --- a/plotly/graph_objects/scattersmith/selected/_marker.py +++ b/plotly/graph_objects/scattersmith/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattersmith/selected/_textfont.py b/plotly/graph_objects/scattersmith/selected/_textfont.py index 101bea0a4b..1b6a383782 100644 --- a/plotly/graph_objects/scattersmith/selected/_textfont.py +++ b/plotly/graph_objects/scattersmith/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scattersmith/unselected/_marker.py b/plotly/graph_objects/scattersmith/unselected/_marker.py index 61c2b38504..28d4ef0b2a 100644 --- a/plotly/graph_objects/scattersmith/unselected/_marker.py +++ b/plotly/graph_objects/scattersmith/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scattersmith/unselected/_textfont.py b/plotly/graph_objects/scattersmith/unselected/_textfont.py index c2cb81cef6..c13166fc6c 100644 --- a/plotly/graph_objects/scattersmith/unselected/_textfont.py +++ b/plotly/graph_objects/scattersmith/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatterternary/_hoverlabel.py b/plotly/graph_objects/scatterternary/_hoverlabel.py index fbf594d1c4..86e0ff2318 100644 --- a/plotly/graph_objects/scatterternary/_hoverlabel.py +++ b/plotly/graph_objects/scatterternary/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/scatterternary/_legendgrouptitle.py b/plotly/graph_objects/scatterternary/_legendgrouptitle.py index df28e30a74..ecff5c45f7 100644 --- a/plotly/graph_objects/scatterternary/_legendgrouptitle.py +++ b/plotly/graph_objects/scatterternary/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterternary/_line.py b/plotly/graph_objects/scatterternary/_line.py index 8541f40dad..618b48b4c9 100644 --- a/plotly/graph_objects/scatterternary/_line.py +++ b/plotly/graph_objects/scatterternary/_line.py @@ -27,8 +27,10 @@ def backoff(self): markers if `marker.angleref` is set to "previous". The 'backoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -64,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -89,10 +92,14 @@ def dash(self): "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.) + + - 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 ------- @@ -112,8 +119,10 @@ def shape(self): 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'] + + - One of the following enumeration values: + + ['linear', 'spline'] Returns ------- @@ -133,7 +142,8 @@ def smoothing(self): 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] + + - An int or float in the interval [0, 1.3] Returns ------- @@ -151,7 +161,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterternary/_marker.py b/plotly/graph_objects/scatterternary/_marker.py index 557db7df5b..a766e298fb 100644 --- a/plotly/graph_objects/scatterternary/_marker.py +++ b/plotly/graph_objects/scatterternary/_marker.py @@ -68,8 +68,10 @@ def angleref(self): "up", angle 0 points toward the top of the screen. The 'angleref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['previous', 'up'] + + - One of the following enumeration values: + + ['previous', 'up'] Returns ------- @@ -156,7 +158,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -179,7 +181,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -201,7 +203,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -222,14 +224,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatterternary.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to scatterternary.marker.colorscale + - A list or array of any of the above Returns ------- @@ -271,9 +273,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -302,30 +304,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -360,9 +363,9 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.Gradient` - - A dict of string/value properties that will be passed - to the Gradient constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.Gradient` + - A dict of string/value properties that will be passed to the Gradient constructor Returns ------- @@ -379,9 +382,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -400,7 +403,8 @@ def maxdisplayed(self): corresponds to no limit. The 'maxdisplayed' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -418,8 +422,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -496,8 +502,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -517,7 +525,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -537,8 +546,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -559,7 +570,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -598,8 +609,10 @@ def standoff(self): arrowhead marker at it. The 'standoff' 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -638,97 +651,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterternary/_selected.py b/plotly/graph_objects/scatterternary/_selected.py index aa9cf4dd5b..049e2b66e0 100644 --- a/plotly/graph_objects/scatterternary/_selected.py +++ b/plotly/graph_objects/scatterternary/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.selected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.selected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatterternary/_stream.py b/plotly/graph_objects/scatterternary/_stream.py index 5d18c51d00..fe94d21faa 100644 --- a/plotly/graph_objects/scatterternary/_stream.py +++ b/plotly/graph_objects/scatterternary/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/scatterternary/_textfont.py b/plotly/graph_objects/scatterternary/_textfont.py index eead237d62..54492a14c5 100644 --- a/plotly/graph_objects/scatterternary/_textfont.py +++ b/plotly/graph_objects/scatterternary/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatterternary/_unselected.py b/plotly/graph_objects/scatterternary/_unselected.py index 4667f9dfd3..eee96ff549 100644 --- a/plotly/graph_objects/scatterternary/_unselected.py +++ b/plotly/graph_objects/scatterternary/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- @@ -34,9 +34,9 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.unselected.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.unselected.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- diff --git a/plotly/graph_objects/scatterternary/hoverlabel/_font.py b/plotly/graph_objects/scatterternary/hoverlabel/_font.py index 8702472f64..5dd4e15402 100644 --- a/plotly/graph_objects/scatterternary/hoverlabel/_font.py +++ b/plotly/graph_objects/scatterternary/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/scatterternary/legendgrouptitle/_font.py b/plotly/graph_objects/scatterternary/legendgrouptitle/_font.py index af012f9cf6..f43a152e2b 100644 --- a/plotly/graph_objects/scatterternary/legendgrouptitle/_font.py +++ b/plotly/graph_objects/scatterternary/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterternary/marker/_colorbar.py b/plotly/graph_objects/scatterternary/marker/_colorbar.py index 5c189a6076..21e18194bb 100644 --- a/plotly/graph_objects/scatterternary/marker/_colorbar.py +++ b/plotly/graph_objects/scatterternary/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.scatterternary.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.scatterternary.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/scatterternary/marker/_gradient.py b/plotly/graph_objects/scatterternary/marker/_gradient.py index f2d7cc71fb..e0afc79f70 100644 --- a/plotly/graph_objects/scatterternary/marker/_gradient.py +++ b/plotly/graph_objects/scatterternary/marker/_gradient.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,9 +59,12 @@ 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 + + - One of the following enumeration values: + + ['radial', 'horizontal', 'vertical', 'none'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterternary/marker/_line.py b/plotly/graph_objects/scatterternary/marker/_line.py index 6a8ecb348c..ec569f9bb8 100644 --- a/plotly/graph_objects/scatterternary/marker/_line.py +++ b/plotly/graph_objects/scatterternary/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to scatterternary.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/scatterternary/marker/colorbar/_tickfont.py b/plotly/graph_objects/scatterternary/marker/colorbar/_tickfont.py index 5fb782c193..2584246f6f 100644 --- a/plotly/graph_objects/scatterternary/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/scatterternary/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterternary/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/scatterternary/marker/colorbar/_tickformatstop.py index a49dca1432..79f226b3a3 100644 --- a/plotly/graph_objects/scatterternary/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/scatterternary/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterternary/marker/colorbar/_title.py b/plotly/graph_objects/scatterternary/marker/colorbar/_title.py index 1761382c0f..5f95fc787e 100644 --- a/plotly/graph_objects/scatterternary/marker/colorbar/_title.py +++ b/plotly/graph_objects/scatterternary/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.scatterternary.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/scatterternary/marker/colorbar/title/_font.py b/plotly/graph_objects/scatterternary/marker/colorbar/title/_font.py index bd8d4ccf84..f41eced3c8 100644 --- a/plotly/graph_objects/scatterternary/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/scatterternary/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/scatterternary/selected/_marker.py b/plotly/graph_objects/scatterternary/selected/_marker.py index bc15ad11f4..446184a675 100644 --- a/plotly/graph_objects/scatterternary/selected/_marker.py +++ b/plotly/graph_objects/scatterternary/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterternary/selected/_textfont.py b/plotly/graph_objects/scatterternary/selected/_textfont.py index 42847c2475..4d7fa6fa92 100644 --- a/plotly/graph_objects/scatterternary/selected/_textfont.py +++ b/plotly/graph_objects/scatterternary/selected/_textfont.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/scatterternary/unselected/_marker.py b/plotly/graph_objects/scatterternary/unselected/_marker.py index 54ec89a5fc..c6d3580cf8 100644 --- a/plotly/graph_objects/scatterternary/unselected/_marker.py +++ b/plotly/graph_objects/scatterternary/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/scatterternary/unselected/_textfont.py b/plotly/graph_objects/scatterternary/unselected/_textfont.py index aab5b94a5d..28000ef2a6 100644 --- a/plotly/graph_objects/scatterternary/unselected/_textfont.py +++ b/plotly/graph_objects/scatterternary/unselected/_textfont.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/splom/_dimension.py b/plotly/graph_objects/splom/_dimension.py index 93daf1af0e..ad40737058 100644 --- a/plotly/graph_objects/splom/_dimension.py +++ b/plotly/graph_objects/splom/_dimension.py @@ -23,9 +23,9 @@ def axis(self): """ The 'axis' property is an instance of Axis that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.dimension.Axis` - - A dict of string/value properties that will be passed - to the Axis constructor + + - An instance of :class:`plotly.graph_objects.splom.dimension.Axis` + - A dict of string/value properties that will be passed to the Axis constructor Returns ------- @@ -43,8 +43,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -68,8 +70,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -94,8 +98,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/splom/_hoverlabel.py b/plotly/graph_objects/splom/_hoverlabel.py index 00b8f342e2..204791dff6 100644 --- a/plotly/graph_objects/splom/_hoverlabel.py +++ b/plotly/graph_objects/splom/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.splom.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/splom/_legendgrouptitle.py b/plotly/graph_objects/splom/_legendgrouptitle.py index cca0e891c4..f347ac14ac 100644 --- a/plotly/graph_objects/splom/_legendgrouptitle.py +++ b/plotly/graph_objects/splom/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.splom.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/splom/_marker.py b/plotly/graph_objects/splom/_marker.py index b3ff0d9d7b..9a1e115da4 100644 --- a/plotly/graph_objects/splom/_marker.py +++ b/plotly/graph_objects/splom/_marker.py @@ -130,7 +130,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -153,7 +153,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -175,7 +175,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -196,14 +196,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to splom.marker.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color according to splom.marker.colorscale + - A list or array of any of the above Returns ------- @@ -245,9 +245,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.splom.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -276,30 +276,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -334,9 +335,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.splom.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -354,8 +355,10 @@ 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -432,8 +435,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -453,7 +458,8 @@ def sizemin(self): points. The 'sizemin' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +479,10 @@ def sizemode(self): to pixels. The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['diameter', 'area'] + + - One of the following enumeration values: + + ['diameter', 'area'] Returns ------- @@ -495,7 +503,7 @@ def sizeref(self): The 'sizeref' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -534,97 +542,93 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/splom/_selected.py b/plotly/graph_objects/splom/_selected.py index 99d2879577..e9c8b2e2ca 100644 --- a/plotly/graph_objects/splom/_selected.py +++ b/plotly/graph_objects/splom/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.splom.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/splom/_stream.py b/plotly/graph_objects/splom/_stream.py index fa84c20505..db02f7a56e 100644 --- a/plotly/graph_objects/splom/_stream.py +++ b/plotly/graph_objects/splom/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/splom/_unselected.py b/plotly/graph_objects/splom/_unselected.py index 7d6b2da042..3b33b9e4b7 100644 --- a/plotly/graph_objects/splom/_unselected.py +++ b/plotly/graph_objects/splom/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.splom.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/splom/dimension/_axis.py b/plotly/graph_objects/splom/dimension/_axis.py index ee46bbebd4..7333314821 100644 --- a/plotly/graph_objects/splom/dimension/_axis.py +++ b/plotly/graph_objects/splom/dimension/_axis.py @@ -38,8 +38,10 @@ def type(self): over this attribute. The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'log', 'date', 'category'] + + - One of the following enumeration values: + + ['linear', 'log', 'date', 'category'] Returns ------- diff --git a/plotly/graph_objects/splom/hoverlabel/_font.py b/plotly/graph_objects/splom/hoverlabel/_font.py index 3bc5f60d80..fba77bf842 100644 --- a/plotly/graph_objects/splom/hoverlabel/_font.py +++ b/plotly/graph_objects/splom/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/splom/legendgrouptitle/_font.py b/plotly/graph_objects/splom/legendgrouptitle/_font.py index e6891cc159..07976f4755 100644 --- a/plotly/graph_objects/splom/legendgrouptitle/_font.py +++ b/plotly/graph_objects/splom/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/splom/marker/_colorbar.py b/plotly/graph_objects/splom/marker/_colorbar.py index 6b2db35f0c..5e82255947 100644 --- a/plotly/graph_objects/splom/marker/_colorbar.py +++ b/plotly/graph_objects/splom/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.splom.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.splom.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/splom/marker/_line.py b/plotly/graph_objects/splom/marker/_line.py index 348f49c41a..a93fc6c76b 100644 --- a/plotly/graph_objects/splom/marker/_line.py +++ b/plotly/graph_objects/splom/marker/_line.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -104,7 +104,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -126,7 +126,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -147,14 +147,14 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list - - A number that will be interpreted as a color - according to splom.marker.line.colorscale - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - 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 ------- @@ -209,30 +209,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -290,8 +291,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/splom/marker/colorbar/_tickfont.py b/plotly/graph_objects/splom/marker/colorbar/_tickfont.py index fa2c861def..46d27a5442 100644 --- a/plotly/graph_objects/splom/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/splom/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/splom/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/splom/marker/colorbar/_tickformatstop.py index f856838f3d..eeb72dcb93 100644 --- a/plotly/graph_objects/splom/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/splom/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/splom/marker/colorbar/_title.py b/plotly/graph_objects/splom/marker/colorbar/_title.py index 461c88fa3b..d2d6871420 100644 --- a/plotly/graph_objects/splom/marker/colorbar/_title.py +++ b/plotly/graph_objects/splom/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.splom.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/splom/marker/colorbar/title/_font.py b/plotly/graph_objects/splom/marker/colorbar/title/_font.py index 35b6a0b547..fd57d9cb14 100644 --- a/plotly/graph_objects/splom/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/splom/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/splom/selected/_marker.py b/plotly/graph_objects/splom/selected/_marker.py index a19741c63a..4ed4e7472f 100644 --- a/plotly/graph_objects/splom/selected/_marker.py +++ b/plotly/graph_objects/splom/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/splom/unselected/_marker.py b/plotly/graph_objects/splom/unselected/_marker.py index b2772ea22c..efdd1a2624 100644 --- a/plotly/graph_objects/splom/unselected/_marker.py +++ b/plotly/graph_objects/splom/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/streamtube/_colorbar.py b/plotly/graph_objects/streamtube/_colorbar.py index 031231d470..3800e8aa35 100644 --- a/plotly/graph_objects/streamtube/_colorbar.py +++ b/plotly/graph_objects/streamtube/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.streamtube.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.streamtube.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.streamtube.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -632,9 +659,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.streamtube.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -655,8 +682,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -676,10 +705,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -702,7 +733,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -721,7 +753,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -745,8 +778,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -764,8 +799,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -785,8 +822,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -804,8 +843,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -898,7 +939,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -915,9 +957,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.streamtube.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -942,7 +984,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -963,8 +1005,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -982,7 +1026,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1002,8 +1047,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1028,7 +1075,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1049,8 +1096,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1068,7 +1117,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1088,8 +1138,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/streamtube/_hoverlabel.py b/plotly/graph_objects/streamtube/_hoverlabel.py index 66895b55fb..3ae0d877fb 100644 --- a/plotly/graph_objects/streamtube/_hoverlabel.py +++ b/plotly/graph_objects/streamtube/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.streamtube.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/streamtube/_legendgrouptitle.py b/plotly/graph_objects/streamtube/_legendgrouptitle.py index 99fd8d8c5e..fff4b1b666 100644 --- a/plotly/graph_objects/streamtube/_legendgrouptitle.py +++ b/plotly/graph_objects/streamtube/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.streamtube.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/streamtube/_lighting.py b/plotly/graph_objects/streamtube/_lighting.py index 5f47700a7c..4e0c175a5d 100644 --- a/plotly/graph_objects/streamtube/_lighting.py +++ b/plotly/graph_objects/streamtube/_lighting.py @@ -25,7 +25,8 @@ def ambient(self): out the image. The 'ambient' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -44,7 +45,8 @@ def diffuse(self): range of angles. The 'diffuse' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -63,7 +65,8 @@ def facenormalsepsilon(self): from degenerate geometry. The 'facenormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -83,7 +86,8 @@ def fresnel(self): 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] + + - An int or float in the interval [0, 5] Returns ------- @@ -102,7 +106,8 @@ def roughness(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -121,7 +126,8 @@ def specular(self): single direction, causing shine. The 'specular' property is a number and may be specified as: - - An int or float in the interval [0, 2] + + - An int or float in the interval [0, 2] Returns ------- @@ -140,7 +146,8 @@ def vertexnormalsepsilon(self): arising from degenerate geometry. The 'vertexnormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/streamtube/_lightposition.py b/plotly/graph_objects/streamtube/_lightposition.py index bf32dba3c5..14e1fc6820 100644 --- a/plotly/graph_objects/streamtube/_lightposition.py +++ b/plotly/graph_objects/streamtube/_lightposition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -34,7 +35,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -52,7 +54,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- diff --git a/plotly/graph_objects/streamtube/_stream.py b/plotly/graph_objects/streamtube/_stream.py index cc37bfdc8c..39da0cbebc 100644 --- a/plotly/graph_objects/streamtube/_stream.py +++ b/plotly/graph_objects/streamtube/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/streamtube/colorbar/_tickfont.py b/plotly/graph_objects/streamtube/colorbar/_tickfont.py index fc5aee5623..471bbf8e45 100644 --- a/plotly/graph_objects/streamtube/colorbar/_tickfont.py +++ b/plotly/graph_objects/streamtube/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/streamtube/colorbar/_tickformatstop.py b/plotly/graph_objects/streamtube/colorbar/_tickformatstop.py index 3e4c13e3ef..ce1864e766 100644 --- a/plotly/graph_objects/streamtube/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/streamtube/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/streamtube/colorbar/_title.py b/plotly/graph_objects/streamtube/colorbar/_title.py index d8792d1b72..2adf98dead 100644 --- a/plotly/graph_objects/streamtube/colorbar/_title.py +++ b/plotly/graph_objects/streamtube/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.streamtube.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.streamtube.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/streamtube/colorbar/title/_font.py b/plotly/graph_objects/streamtube/colorbar/title/_font.py index 32e2b98d49..707710916a 100644 --- a/plotly/graph_objects/streamtube/colorbar/title/_font.py +++ b/plotly/graph_objects/streamtube/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/streamtube/hoverlabel/_font.py b/plotly/graph_objects/streamtube/hoverlabel/_font.py index 07e000244d..cd993205fc 100644 --- a/plotly/graph_objects/streamtube/hoverlabel/_font.py +++ b/plotly/graph_objects/streamtube/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/streamtube/legendgrouptitle/_font.py b/plotly/graph_objects/streamtube/legendgrouptitle/_font.py index 26953f53a9..4cb1b592f8 100644 --- a/plotly/graph_objects/streamtube/legendgrouptitle/_font.py +++ b/plotly/graph_objects/streamtube/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/sunburst/_domain.py b/plotly/graph_objects/sunburst/_domain.py index 2109ba5d86..d1fe8f3c12 100644 --- a/plotly/graph_objects/sunburst/_domain.py +++ b/plotly/graph_objects/sunburst/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this sunburst trace . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this sunburst trace . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/sunburst/_hoverlabel.py b/plotly/graph_objects/sunburst/_hoverlabel.py index 5a4ea3e751..82e8d5c3b0 100644 --- a/plotly/graph_objects/sunburst/_hoverlabel.py +++ b/plotly/graph_objects/sunburst/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sunburst.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/sunburst/_insidetextfont.py b/plotly/graph_objects/sunburst/_insidetextfont.py index 8cd1bf3025..22e704fb9c 100644 --- a/plotly/graph_objects/sunburst/_insidetextfont.py +++ b/plotly/graph_objects/sunburst/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sunburst/_leaf.py b/plotly/graph_objects/sunburst/_leaf.py index b3f63f2ca4..f6034033c8 100644 --- a/plotly/graph_objects/sunburst/_leaf.py +++ b/plotly/graph_objects/sunburst/_leaf.py @@ -17,7 +17,8 @@ def opacity(self): to 1; otherwise it is defaulted to 0.7 The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/sunburst/_legendgrouptitle.py b/plotly/graph_objects/sunburst/_legendgrouptitle.py index fd0264016d..4ecc4da283 100644 --- a/plotly/graph_objects/sunburst/_legendgrouptitle.py +++ b/plotly/graph_objects/sunburst/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sunburst.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/sunburst/_marker.py b/plotly/graph_objects/sunburst/_marker.py index 993c46d4a1..0704c1a32b 100644 --- a/plotly/graph_objects/sunburst/_marker.py +++ b/plotly/graph_objects/sunburst/_marker.py @@ -80,7 +80,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -103,7 +103,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -124,7 +124,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -166,9 +166,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -216,30 +216,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -274,9 +275,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -295,9 +296,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/sunburst/_outsidetextfont.py b/plotly/graph_objects/sunburst/_outsidetextfont.py index 244747f1c5..68ae15379a 100644 --- a/plotly/graph_objects/sunburst/_outsidetextfont.py +++ b/plotly/graph_objects/sunburst/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sunburst/_root.py b/plotly/graph_objects/sunburst/_root.py index ad0032618d..afdee22ac8 100644 --- a/plotly/graph_objects/sunburst/_root.py +++ b/plotly/graph_objects/sunburst/_root.py @@ -18,11 +18,12 @@ def color(self): markers. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/sunburst/_stream.py b/plotly/graph_objects/sunburst/_stream.py index 5a223d6011..8c5f08fba7 100644 --- a/plotly/graph_objects/sunburst/_stream.py +++ b/plotly/graph_objects/sunburst/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/sunburst/_textfont.py b/plotly/graph_objects/sunburst/_textfont.py index 0796cf641f..12d6295f82 100644 --- a/plotly/graph_objects/sunburst/_textfont.py +++ b/plotly/graph_objects/sunburst/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sunburst/hoverlabel/_font.py b/plotly/graph_objects/sunburst/hoverlabel/_font.py index 4e34e4dc97..9f8306cd39 100644 --- a/plotly/graph_objects/sunburst/hoverlabel/_font.py +++ b/plotly/graph_objects/sunburst/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/sunburst/legendgrouptitle/_font.py b/plotly/graph_objects/sunburst/legendgrouptitle/_font.py index e13aad1d3f..113907c58a 100644 --- a/plotly/graph_objects/sunburst/legendgrouptitle/_font.py +++ b/plotly/graph_objects/sunburst/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/sunburst/marker/_colorbar.py b/plotly/graph_objects/sunburst/marker/_colorbar.py index 4fb681caf3..d340c80826 100644 --- a/plotly/graph_objects/sunburst/marker/_colorbar.py +++ b/plotly/graph_objects/sunburst/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.sunburst.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.sunburst.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/sunburst/marker/_line.py b/plotly/graph_objects/sunburst/marker/_line.py index 7cf9c603a2..8985af5512 100644 --- a/plotly/graph_objects/sunburst/marker/_line.py +++ b/plotly/graph_objects/sunburst/marker/_line.py @@ -17,12 +17,13 @@ def color(self): the `paper_bgcolor` value. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,8 +59,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/sunburst/marker/_pattern.py b/plotly/graph_objects/sunburst/marker/_pattern.py index 08fdf08bb7..06ea47023f 100644 --- a/plotly/graph_objects/sunburst/marker/_pattern.py +++ b/plotly/graph_objects/sunburst/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/sunburst/marker/colorbar/_tickfont.py b/plotly/graph_objects/sunburst/marker/colorbar/_tickfont.py index 411ed48e53..cc6013debc 100644 --- a/plotly/graph_objects/sunburst/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/sunburst/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/sunburst/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/sunburst/marker/colorbar/_tickformatstop.py index 8bbccb2c9a..5d45c18f70 100644 --- a/plotly/graph_objects/sunburst/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/sunburst/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/sunburst/marker/colorbar/_title.py b/plotly/graph_objects/sunburst/marker/colorbar/_title.py index b2be2a07c6..834abf69db 100644 --- a/plotly/graph_objects/sunburst/marker/colorbar/_title.py +++ b/plotly/graph_objects/sunburst/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.sunburst.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/sunburst/marker/colorbar/title/_font.py b/plotly/graph_objects/sunburst/marker/colorbar/title/_font.py index 7942584bd3..9ee492fe03 100644 --- a/plotly/graph_objects/sunburst/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/sunburst/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/surface/_colorbar.py b/plotly/graph_objects/surface/_colorbar.py index ee9a5bd25f..5d825eb640 100644 --- a/plotly/graph_objects/surface/_colorbar.py +++ b/plotly/graph_objects/surface/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.surface.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.surface.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.surface.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.surface.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.surface.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/surface/_contours.py b/plotly/graph_objects/surface/_contours.py index 26ebf6ed47..c541d24881 100644 --- a/plotly/graph_objects/surface/_contours.py +++ b/plotly/graph_objects/surface/_contours.py @@ -15,9 +15,9 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.contours.X` - - A dict of string/value properties that will be passed - to the X constructor + + - An instance of :class:`plotly.graph_objects.surface.contours.X` + - A dict of string/value properties that will be passed to the X constructor Returns ------- @@ -34,9 +34,9 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.contours.Y` - - A dict of string/value properties that will be passed - to the Y constructor + + - An instance of :class:`plotly.graph_objects.surface.contours.Y` + - A dict of string/value properties that will be passed to the Y constructor Returns ------- @@ -53,9 +53,9 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.contours.Z` - - A dict of string/value properties that will be passed - to the Z constructor + + - An instance of :class:`plotly.graph_objects.surface.contours.Z` + - A dict of string/value properties that will be passed to the Z constructor Returns ------- diff --git a/plotly/graph_objects/surface/_hoverlabel.py b/plotly/graph_objects/surface/_hoverlabel.py index 5169b181c6..587a55d2aa 100644 --- a/plotly/graph_objects/surface/_hoverlabel.py +++ b/plotly/graph_objects/surface/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.surface.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/surface/_legendgrouptitle.py b/plotly/graph_objects/surface/_legendgrouptitle.py index c59461dc87..c05a325883 100644 --- a/plotly/graph_objects/surface/_legendgrouptitle.py +++ b/plotly/graph_objects/surface/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.surface.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/surface/_lighting.py b/plotly/graph_objects/surface/_lighting.py index d6305c0434..3861c73b8a 100644 --- a/plotly/graph_objects/surface/_lighting.py +++ b/plotly/graph_objects/surface/_lighting.py @@ -17,7 +17,8 @@ def ambient(self): out the image. The 'ambient' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -36,7 +37,8 @@ def diffuse(self): range of angles. The 'diffuse' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ def fresnel(self): 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] + + - An int or float in the interval [0, 5] Returns ------- @@ -75,7 +78,8 @@ def roughness(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -94,7 +98,8 @@ def specular(self): single direction, causing shine. The 'specular' property is a number and may be specified as: - - An int or float in the interval [0, 2] + + - An int or float in the interval [0, 2] Returns ------- diff --git a/plotly/graph_objects/surface/_lightposition.py b/plotly/graph_objects/surface/_lightposition.py index a28cb98cdd..8a8c5bf1c1 100644 --- a/plotly/graph_objects/surface/_lightposition.py +++ b/plotly/graph_objects/surface/_lightposition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -34,7 +35,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -52,7 +54,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- diff --git a/plotly/graph_objects/surface/_stream.py b/plotly/graph_objects/surface/_stream.py index 0c048be298..f028fa6491 100644 --- a/plotly/graph_objects/surface/_stream.py +++ b/plotly/graph_objects/surface/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/surface/colorbar/_tickfont.py b/plotly/graph_objects/surface/colorbar/_tickfont.py index 1dd13fd9fe..46a7f159c5 100644 --- a/plotly/graph_objects/surface/colorbar/_tickfont.py +++ b/plotly/graph_objects/surface/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/surface/colorbar/_tickformatstop.py b/plotly/graph_objects/surface/colorbar/_tickformatstop.py index 5ef572e022..8dfffd9918 100644 --- a/plotly/graph_objects/surface/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/surface/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/surface/colorbar/_title.py b/plotly/graph_objects/surface/colorbar/_title.py index 47d0f99400..2c50921271 100644 --- a/plotly/graph_objects/surface/colorbar/_title.py +++ b/plotly/graph_objects/surface/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.surface.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/surface/colorbar/title/_font.py b/plotly/graph_objects/surface/colorbar/title/_font.py index 3705c091ef..b8e27dc512 100644 --- a/plotly/graph_objects/surface/colorbar/title/_font.py +++ b/plotly/graph_objects/surface/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/surface/contours/_x.py b/plotly/graph_objects/surface/contours/_x.py index 06e1a6f072..5a03d385c9 100644 --- a/plotly/graph_objects/surface/contours/_x.py +++ b/plotly/graph_objects/surface/contours/_x.py @@ -28,11 +28,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -52,7 +53,7 @@ def end(self): The 'end' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -89,11 +90,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -111,7 +113,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- @@ -128,9 +131,9 @@ def project(self): """ The 'project' property is an instance of Project that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.contours.x.Project` - - A dict of string/value properties that will be passed - to the Project constructor + + - An instance of :class:`plotly.graph_objects.surface.contours.x.Project` + - A dict of string/value properties that will be passed to the Project constructor Returns ------- @@ -167,7 +170,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -187,7 +191,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -224,7 +228,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- diff --git a/plotly/graph_objects/surface/contours/_y.py b/plotly/graph_objects/surface/contours/_y.py index 3ad957a81d..92693c4b14 100644 --- a/plotly/graph_objects/surface/contours/_y.py +++ b/plotly/graph_objects/surface/contours/_y.py @@ -28,11 +28,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -52,7 +53,7 @@ def end(self): The 'end' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -89,11 +90,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -111,7 +113,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- @@ -128,9 +131,9 @@ def project(self): """ The 'project' property is an instance of Project that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.contours.y.Project` - - A dict of string/value properties that will be passed - to the Project constructor + + - An instance of :class:`plotly.graph_objects.surface.contours.y.Project` + - A dict of string/value properties that will be passed to the Project constructor Returns ------- @@ -167,7 +170,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -187,7 +191,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -224,7 +228,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- diff --git a/plotly/graph_objects/surface/contours/_z.py b/plotly/graph_objects/surface/contours/_z.py index 8bea45ec56..997df6747b 100644 --- a/plotly/graph_objects/surface/contours/_z.py +++ b/plotly/graph_objects/surface/contours/_z.py @@ -28,11 +28,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -52,7 +53,7 @@ def end(self): The 'end' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -89,11 +90,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -111,7 +113,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- @@ -128,9 +131,9 @@ def project(self): """ The 'project' property is an instance of Project that may be specified as: - - An instance of :class:`plotly.graph_objects.surface.contours.z.Project` - - A dict of string/value properties that will be passed - to the Project constructor + + - An instance of :class:`plotly.graph_objects.surface.contours.z.Project` + - A dict of string/value properties that will be passed to the Project constructor Returns ------- @@ -167,7 +170,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -187,7 +191,7 @@ def start(self): The 'start' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -224,7 +228,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- diff --git a/plotly/graph_objects/surface/hoverlabel/_font.py b/plotly/graph_objects/surface/hoverlabel/_font.py index e5896853a2..764c3fcac9 100644 --- a/plotly/graph_objects/surface/hoverlabel/_font.py +++ b/plotly/graph_objects/surface/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/surface/legendgrouptitle/_font.py b/plotly/graph_objects/surface/legendgrouptitle/_font.py index c84fe3e3c1..ab8e265a92 100644 --- a/plotly/graph_objects/surface/legendgrouptitle/_font.py +++ b/plotly/graph_objects/surface/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/table/_cells.py b/plotly/graph_objects/table/_cells.py index 2378859061..e58b681e69 100644 --- a/plotly/graph_objects/table/_cells.py +++ b/plotly/graph_objects/table/_cells.py @@ -34,9 +34,12 @@ def align(self): 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 + + - One of the following enumeration values: + + ['left', 'center', 'right'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -71,9 +74,9 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of :class:`plotly.graph_objects.table.cells.Fill` - - A dict of string/value properties that will be passed - to the Fill constructor + + - An instance of :class:`plotly.graph_objects.table.cells.Fill` + - A dict of string/value properties that will be passed to the Fill constructor Returns ------- @@ -90,9 +93,9 @@ def font(self): """ The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.table.cells.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.table.cells.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -150,7 +153,7 @@ def height(self): The 'height' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -167,9 +170,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.table.cells.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.table.cells.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -187,9 +190,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -225,9 +231,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/table/_domain.py b/plotly/graph_objects/table/_domain.py index 8202718222..2042feb554 100644 --- a/plotly/graph_objects/table/_domain.py +++ b/plotly/graph_objects/table/_domain.py @@ -17,7 +17,8 @@ def column(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): 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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/table/_header.py b/plotly/graph_objects/table/_header.py index f956499e42..f6a8abae1b 100644 --- a/plotly/graph_objects/table/_header.py +++ b/plotly/graph_objects/table/_header.py @@ -34,9 +34,12 @@ def align(self): 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 + + - One of the following enumeration values: + + ['left', 'center', 'right'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -71,9 +74,9 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of :class:`plotly.graph_objects.table.header.Fill` - - A dict of string/value properties that will be passed - to the Fill constructor + + - An instance of :class:`plotly.graph_objects.table.header.Fill` + - A dict of string/value properties that will be passed to the Fill constructor Returns ------- @@ -90,9 +93,9 @@ def font(self): """ The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.table.header.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.table.header.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -150,7 +153,7 @@ def height(self): The 'height' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -167,9 +170,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.table.header.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.table.header.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -187,9 +190,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -225,9 +231,12 @@ 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 + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/table/_hoverlabel.py b/plotly/graph_objects/table/_hoverlabel.py index d6ceca1e3b..6f68853db5 100644 --- a/plotly/graph_objects/table/_hoverlabel.py +++ b/plotly/graph_objects/table/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.table.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.table.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/table/_legendgrouptitle.py b/plotly/graph_objects/table/_legendgrouptitle.py index 655866e6ec..9b444104db 100644 --- a/plotly/graph_objects/table/_legendgrouptitle.py +++ b/plotly/graph_objects/table/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.table.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.table.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/table/_stream.py b/plotly/graph_objects/table/_stream.py index 005e0d9b67..86531c8704 100644 --- a/plotly/graph_objects/table/_stream.py +++ b/plotly/graph_objects/table/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/table/cells/_fill.py b/plotly/graph_objects/table/cells/_fill.py index 3dd81d5b9a..a1197a2a2d 100644 --- a/plotly/graph_objects/table/cells/_fill.py +++ b/plotly/graph_objects/table/cells/_fill.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- diff --git a/plotly/graph_objects/table/cells/_font.py b/plotly/graph_objects/table/cells/_font.py index d316e28e38..e189e9634d 100644 --- a/plotly/graph_objects/table/cells/_font.py +++ b/plotly/graph_objects/table/cells/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/table/cells/_line.py b/plotly/graph_objects/table/cells/_line.py index b3132dc50a..b7f4650f49 100644 --- a/plotly/graph_objects/table/cells/_line.py +++ b/plotly/graph_objects/table/cells/_line.py @@ -14,12 +14,13 @@ class Line(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -54,8 +55,9 @@ 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 + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/table/header/_fill.py b/plotly/graph_objects/table/header/_fill.py index dd5ca5a55c..b9d60eb0bd 100644 --- a/plotly/graph_objects/table/header/_fill.py +++ b/plotly/graph_objects/table/header/_fill.py @@ -17,12 +17,13 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- diff --git a/plotly/graph_objects/table/header/_font.py b/plotly/graph_objects/table/header/_font.py index 20ead1f1ab..dc6fcf9213 100644 --- a/plotly/graph_objects/table/header/_font.py +++ b/plotly/graph_objects/table/header/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/table/header/_line.py b/plotly/graph_objects/table/header/_line.py index adf8715fd3..b7a0b62919 100644 --- a/plotly/graph_objects/table/header/_line.py +++ b/plotly/graph_objects/table/header/_line.py @@ -14,12 +14,13 @@ class Line(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -54,8 +55,9 @@ 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 + - An int or float + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/table/hoverlabel/_font.py b/plotly/graph_objects/table/hoverlabel/_font.py index 688e1c407c..3611070b17 100644 --- a/plotly/graph_objects/table/hoverlabel/_font.py +++ b/plotly/graph_objects/table/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/table/legendgrouptitle/_font.py b/plotly/graph_objects/table/legendgrouptitle/_font.py index 675cc4a349..74831ac429 100644 --- a/plotly/graph_objects/table/legendgrouptitle/_font.py +++ b/plotly/graph_objects/table/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/treemap/_domain.py b/plotly/graph_objects/treemap/_domain.py index b00df20fee..26de22e5c3 100644 --- a/plotly/graph_objects/treemap/_domain.py +++ b/plotly/graph_objects/treemap/_domain.py @@ -17,7 +17,8 @@ def column(self): the grid for this treemap trace . The 'column' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -37,7 +38,8 @@ def row(self): grid for this treemap trace . The 'row' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -61,10 +63,12 @@ def x(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -87,10 +91,12 @@ def y(self): * 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] + + - 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/treemap/_hoverlabel.py b/plotly/graph_objects/treemap/_hoverlabel.py index b13ee99bd6..3c6d566078 100644 --- a/plotly/graph_objects/treemap/_hoverlabel.py +++ b/plotly/graph_objects/treemap/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.treemap.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/treemap/_insidetextfont.py b/plotly/graph_objects/treemap/_insidetextfont.py index 33b0801bd7..fceb33bb7e 100644 --- a/plotly/graph_objects/treemap/_insidetextfont.py +++ b/plotly/graph_objects/treemap/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/treemap/_legendgrouptitle.py b/plotly/graph_objects/treemap/_legendgrouptitle.py index ca8173d1b4..3420dd6660 100644 --- a/plotly/graph_objects/treemap/_legendgrouptitle.py +++ b/plotly/graph_objects/treemap/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.treemap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/treemap/_marker.py b/plotly/graph_objects/treemap/_marker.py index 000211589c..dc8232b64a 100644 --- a/plotly/graph_objects/treemap/_marker.py +++ b/plotly/graph_objects/treemap/_marker.py @@ -83,7 +83,7 @@ def cmax(self): The 'cmax' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -106,7 +106,7 @@ def cmid(self): The 'cmid' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -127,7 +127,7 @@ def cmin(self): The 'cmin' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -169,9 +169,9 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.ColorBar` - - A dict of string/value properties that will be passed - to the ColorBar constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.ColorBar` + - A dict of string/value properties that will be passed to the ColorBar constructor Returns ------- @@ -219,30 +219,31 @@ def colorscale(self): The 'colorscale' property is a colorscale and may be specified as: - - A list of colors that will be spaced evenly to create the colorscale. + + - A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package. - - A list of 2-element lists where the first element is the + - A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', - 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', - 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', - 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', - 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', - 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', - 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', - 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', - 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', - 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', - 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', - 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', - 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', - 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', - 'ylorrd']. - Appending '_r' to a named colorscale reverses it. + - One of the following named colorscales: + + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', 'brwnyl', + 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', 'darkmint', 'deep', + 'delta', 'dense', 'earth', 'edge', 'electric', 'emrld', 'fall', + 'geyser', 'gnbu', 'gray', 'greens', 'greys', 'haline', 'hot', 'hsv', + 'ice', 'icefire', 'inferno', 'jet', 'magenta', 'magma', 'matter', + 'mint', 'mrybm', 'mygbm', 'oranges', 'orrd', 'oryel', 'oxy', 'peach', + 'phase', 'picnic', 'pinkyl', 'piyg', 'plasma', 'plotly3', 'portland', + 'prgn', 'pubu', 'pubugn', 'puor', 'purd', 'purp', 'purples', 'purpor', + 'rainbow', 'rdbu', 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', + 'solar', 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', 'turbo', + 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', 'ylorrd']. + + Appending '_r' to a named colorscale reverses it. Returns ------- @@ -278,7 +279,8 @@ def cornerradius(self): Sets the maximum rounding of corners (in px). The 'cornerradius' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -303,8 +305,10 @@ def depthfade(self): background color. The 'depthfade' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, False, 'reversed'] + + - One of the following enumeration values: + + [True, False, 'reversed'] Returns ------- @@ -321,9 +325,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -340,9 +344,9 @@ def pad(self): """ The 'pad' property is an instance of Pad that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.Pad` - - A dict of string/value properties that will be passed - to the Pad constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.Pad` + - A dict of string/value properties that will be passed to the Pad constructor Returns ------- @@ -361,9 +365,9 @@ def pattern(self): The 'pattern' property is an instance of Pattern that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.Pattern` - - A dict of string/value properties that will be passed - to the Pattern constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.Pattern` + - A dict of string/value properties that will be passed to the Pattern constructor Returns ------- diff --git a/plotly/graph_objects/treemap/_outsidetextfont.py b/plotly/graph_objects/treemap/_outsidetextfont.py index 1b94661c35..10aa990f43 100644 --- a/plotly/graph_objects/treemap/_outsidetextfont.py +++ b/plotly/graph_objects/treemap/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/treemap/_pathbar.py b/plotly/graph_objects/treemap/_pathbar.py index 20493efd0c..44e5ae6c28 100644 --- a/plotly/graph_objects/treemap/_pathbar.py +++ b/plotly/graph_objects/treemap/_pathbar.py @@ -17,8 +17,10 @@ def edgeshape(self): labels. The 'edgeshape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['>', '<', '|', '/', '\\'] + + - One of the following enumeration values: + + ['>', '<', '|', '/', '\\'] Returns ------- @@ -37,8 +39,10 @@ def side(self): should be presented. The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'bottom'] + + - One of the following enumeration values: + + ['top', 'bottom'] Returns ------- @@ -57,9 +61,9 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.pathbar.Textfont` - - A dict of string/value properties that will be passed - to the Textfont constructor + + - An instance of :class:`plotly.graph_objects.treemap.pathbar.Textfont` + - A dict of string/value properties that will be passed to the Textfont constructor Returns ------- @@ -79,7 +83,8 @@ def thickness(self): each side. The 'thickness' property is a number and may be specified as: - - An int or float in the interval [12, inf] + + - An int or float in the interval [12, inf] Returns ------- diff --git a/plotly/graph_objects/treemap/_root.py b/plotly/graph_objects/treemap/_root.py index 4caaddd68e..3c6d30cfc8 100644 --- a/plotly/graph_objects/treemap/_root.py +++ b/plotly/graph_objects/treemap/_root.py @@ -18,11 +18,12 @@ def color(self): markers. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- diff --git a/plotly/graph_objects/treemap/_stream.py b/plotly/graph_objects/treemap/_stream.py index 1b64cc6ba3..58afb8244b 100644 --- a/plotly/graph_objects/treemap/_stream.py +++ b/plotly/graph_objects/treemap/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/treemap/_textfont.py b/plotly/graph_objects/treemap/_textfont.py index 809bd2f505..36ce6ed86c 100644 --- a/plotly/graph_objects/treemap/_textfont.py +++ b/plotly/graph_objects/treemap/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/treemap/_tiling.py b/plotly/graph_objects/treemap/_tiling.py index ce78eda1e3..04180f0eee 100644 --- a/plotly/graph_objects/treemap/_tiling.py +++ b/plotly/graph_objects/treemap/_tiling.py @@ -18,7 +18,8 @@ def flip(self): The 'flip' property is a flaglist and may be specified as a string containing: - - Any combination of ['x', 'y'] joined with '+' characters + + - Any combination of ['x', 'y'] joined with '+' characters (e.g. 'x+y') Returns @@ -38,9 +39,11 @@ def packing(self): https://github.com/d3/d3-hierarchy#treemap-tiling The 'packing' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['squarify', 'binary', 'dice', 'slice', 'slice-dice', - 'dice-slice'] + + - One of the following enumeration values: + + ['squarify', 'binary', 'dice', 'slice', 'slice-dice', + 'dice-slice'] Returns ------- @@ -58,7 +61,8 @@ def pad(self): Sets the inner padding (in px). The 'pad' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -87,7 +91,8 @@ def squarifyratio(self): layouts. The 'squarifyratio' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- diff --git a/plotly/graph_objects/treemap/hoverlabel/_font.py b/plotly/graph_objects/treemap/hoverlabel/_font.py index f5f60daa11..7d0a232519 100644 --- a/plotly/graph_objects/treemap/hoverlabel/_font.py +++ b/plotly/graph_objects/treemap/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/treemap/legendgrouptitle/_font.py b/plotly/graph_objects/treemap/legendgrouptitle/_font.py index 47f6f9c6c7..d949639456 100644 --- a/plotly/graph_objects/treemap/legendgrouptitle/_font.py +++ b/plotly/graph_objects/treemap/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/treemap/marker/_colorbar.py b/plotly/graph_objects/treemap/marker/_colorbar.py index 7858178304..8951c5c93b 100644 --- a/plotly/graph_objects/treemap/marker/_colorbar.py +++ b/plotly/graph_objects/treemap/marker/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.treemap.marker.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.treemap.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/treemap/marker/_line.py b/plotly/graph_objects/treemap/marker/_line.py index 1985da51a6..4ad7832c9f 100644 --- a/plotly/graph_objects/treemap/marker/_line.py +++ b/plotly/graph_objects/treemap/marker/_line.py @@ -17,12 +17,13 @@ def color(self): the `paper_bgcolor` value. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -58,8 +59,10 @@ 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/treemap/marker/_pad.py b/plotly/graph_objects/treemap/marker/_pad.py index e3a61b8451..32f933a2a3 100644 --- a/plotly/graph_objects/treemap/marker/_pad.py +++ b/plotly/graph_objects/treemap/marker/_pad.py @@ -16,7 +16,8 @@ def b(self): Sets the padding form the bottom (in px). The 'b' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -34,7 +35,8 @@ def l(self): Sets the padding form the left (in px). The 'l' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -52,7 +54,8 @@ def r(self): Sets the padding form the right (in px). The 'r' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -70,7 +73,8 @@ def t(self): Sets the padding form the top (in px). The 't' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/treemap/marker/_pattern.py b/plotly/graph_objects/treemap/marker/_pattern.py index 96c1de4eb7..000fd8ec96 100644 --- a/plotly/graph_objects/treemap/marker/_pattern.py +++ b/plotly/graph_objects/treemap/marker/_pattern.py @@ -34,12 +34,13 @@ def bgcolor(self): background. 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,12 +79,13 @@ def fgcolor(self): white to increase contrast with the `bgcolor`. The 'fgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -120,7 +122,8 @@ def fgopacity(self): 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. The 'fgopacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -139,8 +142,10 @@ def fillmode(self): to `bgcolor` or a `fgcolor`. The 'fillmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['replace', 'overlay'] + + - One of the following enumeration values: + + ['replace', 'overlay'] Returns ------- @@ -160,9 +165,12 @@ def path(self): square from (0,0) to (`size`,`size`) to color. The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -199,9 +207,12 @@ def shape(self): used for filling the area. The 'shape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', '/', '\\', 'x', '-', '|', '+', '.'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['', '/', '\\', 'x', '-', '|', '+', '.'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -238,8 +249,10 @@ def size(self): which corresponds to the interval of repetition of the pattern. 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 + + - An int or float in the interval [0, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -278,8 +291,10 @@ def solidity(self): shows only the foreground color without pattern. The 'solidity' 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 + + - An int or float in the interval [0, 1] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- diff --git a/plotly/graph_objects/treemap/marker/colorbar/_tickfont.py b/plotly/graph_objects/treemap/marker/colorbar/_tickfont.py index 80d083568c..f04fbed57b 100644 --- a/plotly/graph_objects/treemap/marker/colorbar/_tickfont.py +++ b/plotly/graph_objects/treemap/marker/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/treemap/marker/colorbar/_tickformatstop.py b/plotly/graph_objects/treemap/marker/colorbar/_tickformatstop.py index ce808d6c2d..9f3753ecbd 100644 --- a/plotly/graph_objects/treemap/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/treemap/marker/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/treemap/marker/colorbar/_title.py b/plotly/graph_objects/treemap/marker/colorbar/_title.py index 200a434b87..557c2daa25 100644 --- a/plotly/graph_objects/treemap/marker/colorbar/_title.py +++ b/plotly/graph_objects/treemap/marker/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.treemap.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/treemap/marker/colorbar/title/_font.py b/plotly/graph_objects/treemap/marker/colorbar/title/_font.py index 22649b4356..7e230bae38 100644 --- a/plotly/graph_objects/treemap/marker/colorbar/title/_font.py +++ b/plotly/graph_objects/treemap/marker/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/treemap/pathbar/_textfont.py b/plotly/graph_objects/treemap/pathbar/_textfont.py index 5b590c076b..c873a56d46 100644 --- a/plotly/graph_objects/treemap/pathbar/_textfont.py +++ b/plotly/graph_objects/treemap/pathbar/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/violin/_box.py b/plotly/graph_objects/violin/_box.py index 6fb9e4172e..04c839a3bf 100644 --- a/plotly/graph_objects/violin/_box.py +++ b/plotly/graph_objects/violin/_box.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.box.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.violin.box.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -78,7 +79,8 @@ def width(self): the violins. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/violin/_hoverlabel.py b/plotly/graph_objects/violin/_hoverlabel.py index 49a4e405e4..49b3721436 100644 --- a/plotly/graph_objects/violin/_hoverlabel.py +++ b/plotly/graph_objects/violin/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.violin.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/violin/_legendgrouptitle.py b/plotly/graph_objects/violin/_legendgrouptitle.py index c4c21aa6ed..ff10e0c0f2 100644 --- a/plotly/graph_objects/violin/_legendgrouptitle.py +++ b/plotly/graph_objects/violin/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.violin.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/violin/_line.py b/plotly/graph_objects/violin/_line.py index b4edcea434..493ebb11d0 100644 --- a/plotly/graph_objects/violin/_line.py +++ b/plotly/graph_objects/violin/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/violin/_marker.py b/plotly/graph_objects/violin/_marker.py index e121210337..6b471029f1 100644 --- a/plotly/graph_objects/violin/_marker.py +++ b/plotly/graph_objects/violin/_marker.py @@ -47,11 +47,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -68,9 +69,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.violin.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -88,7 +89,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -106,11 +108,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -128,7 +131,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -149,96 +153,91 @@ def symbol(self): appending "-open-dot" or "dot-open" to a symbol name. The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', - 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', - 'square', 101, '101', 'square-open', 201, '201', - 'square-dot', 301, '301', 'square-open-dot', 2, '2', - 'diamond', 102, '102', 'diamond-open', 202, '202', - 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', - 'cross', 103, '103', 'cross-open', 203, '203', - 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', - 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', - 'x-open-dot', 5, '5', 'triangle-up', 105, '105', - 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, - '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', - 106, '106', 'triangle-down-open', 206, '206', - 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', - 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', - 207, '207', 'triangle-left-dot', 307, '307', - 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, - '108', 'triangle-right-open', 208, '208', - 'triangle-right-dot', 308, '308', - 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, - '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', - 309, '309', 'triangle-ne-open-dot', 10, '10', - 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', - 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, - '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, - '211', 'triangle-sw-dot', 311, '311', - 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, - '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', - 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', - 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', - 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, - '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, - '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, - '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, - '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, - '116', 'octagon-open', 216, '216', 'octagon-dot', 316, - '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', - 'star-open', 217, '217', 'star-dot', 317, '317', - 'star-open-dot', 18, '18', 'hexagram', 118, '118', - 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', - 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, - '119', 'star-triangle-up-open', 219, '219', - 'star-triangle-up-dot', 319, '319', - 'star-triangle-up-open-dot', 20, '20', - 'star-triangle-down', 120, '120', - 'star-triangle-down-open', 220, '220', - 'star-triangle-down-dot', 320, '320', - 'star-triangle-down-open-dot', 21, '21', 'star-square', - 121, '121', 'star-square-open', 221, '221', - 'star-square-dot', 321, '321', 'star-square-open-dot', 22, - '22', 'star-diamond', 122, '122', 'star-diamond-open', - 222, '222', 'star-diamond-dot', 322, '322', - 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, - '123', 'diamond-tall-open', 223, '223', - 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', - 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', - 224, '224', 'diamond-wide-dot', 324, '324', - 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, - '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', - 'bowtie-open', 27, '27', 'circle-cross', 127, '127', - 'circle-cross-open', 28, '28', 'circle-x', 128, '128', - 'circle-x-open', 29, '29', 'square-cross', 129, '129', - 'square-cross-open', 30, '30', 'square-x', 130, '130', - 'square-x-open', 31, '31', 'diamond-cross', 131, '131', - 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', - 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', - 'cross-thin-open', 34, '34', 'x-thin', 134, '134', - 'x-thin-open', 35, '35', 'asterisk', 135, '135', - 'asterisk-open', 36, '36', 'hash', 136, '136', - 'hash-open', 236, '236', 'hash-dot', 336, '336', - 'hash-open-dot', 37, '37', 'y-up', 137, '137', - 'y-up-open', 38, '38', 'y-down', 138, '138', - 'y-down-open', 39, '39', 'y-left', 139, '139', - 'y-left-open', 40, '40', 'y-right', 140, '140', - 'y-right-open', 41, '41', 'line-ew', 141, '141', - 'line-ew-open', 42, '42', 'line-ns', 142, '142', - 'line-ns-open', 43, '43', 'line-ne', 143, '143', - 'line-ne-open', 44, '44', 'line-nw', 144, '144', - 'line-nw-open', 45, '45', 'arrow-up', 145, '145', - 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', - 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', - 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', - 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', - 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, - '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', - 151, '151', 'arrow-bar-left-open', 52, '52', - 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, - '53', 'arrow', 153, '153', 'arrow-open', 54, '54', - 'arrow-wide', 154, '154', 'arrow-wide-open'] + + - One of the following enumeration values: + + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', 'square', + 101, '101', 'square-open', 201, '201', 'square-dot', 301, + '301', 'square-open-dot', 2, '2', 'diamond', 102, '102', + 'diamond-open', 202, '202', 'diamond-dot', 302, '302', + 'diamond-open-dot', 3, '3', 'cross', 103, '103', 'cross-open', + 203, '203', 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', + 'x', 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, '305', + 'triangle-up-open-dot', 6, '6', 'triangle-down', 106, '106', + 'triangle-down-open', 206, '206', 'triangle-down-dot', 306, + '306', 'triangle-down-open-dot', 7, '7', 'triangle-left', 107, + '107', 'triangle-left-open', 207, '207', 'triangle-left-dot', + 307, '307', 'triangle-left-open-dot', 8, '8', + 'triangle-right', 108, '108', 'triangle-right-open', 208, + '208', 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, '109', + 'triangle-ne-open', 209, '209', 'triangle-ne-dot', 309, '309', + 'triangle-ne-open-dot', 10, '10', 'triangle-se', 110, '110', + 'triangle-se-open', 210, '210', 'triangle-se-dot', 310, '310', + 'triangle-se-open-dot', 11, '11', 'triangle-sw', 111, '111', + 'triangle-sw-open', 211, '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, '112', + 'triangle-nw-open', 212, '212', 'triangle-nw-dot', 312, '312', + 'triangle-nw-open-dot', 13, '13', 'pentagon', 113, '113', + 'pentagon-open', 213, '213', 'pentagon-dot', 313, '313', + 'pentagon-open-dot', 14, '14', 'hexagon', 114, '114', + 'hexagon-open', 214, '214', 'hexagon-dot', 314, '314', + 'hexagon-open-dot', 15, '15', 'hexagon2', 115, '115', + 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, '315', + 'hexagon2-open-dot', 16, '16', 'octagon', 116, '116', + 'octagon-open', 216, '216', 'octagon-dot', 316, '316', + 'octagon-open-dot', 17, '17', 'star', 117, '117', 'star-open', + 217, '217', 'star-dot', 317, '317', 'star-open-dot', 18, '18', + 'hexagram', 118, '118', 'hexagram-open', 218, '218', + 'hexagram-dot', 318, '318', 'hexagram-open-dot', 19, '19', + 'star-triangle-up', 119, '119', 'star-triangle-up-open', 219, + '219', 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', 'star-triangle-down', + 120, '120', 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', 121, + '121', 'star-square-open', 221, '221', 'star-square-dot', 321, + '321', 'star-square-open-dot', 22, '22', 'star-diamond', 122, + '122', 'star-diamond-open', 222, '222', 'star-diamond-dot', + 322, '322', 'star-diamond-open-dot', 23, '23', 'diamond-tall', + 123, '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', 24, + '24', 'diamond-wide', 124, '124', 'diamond-wide-open', 224, + '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, '125', + 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', 'hash-open', + 236, '236', 'hash-dot', 336, '336', 'hash-open-dot', 37, '37', + 'y-up', 137, '137', 'y-up-open', 38, '38', 'y-down', 138, + '138', 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, '150', + 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', 151, '151', + 'arrow-bar-left-open', 52, '52', 'arrow-bar-right', 152, + '152', 'arrow-bar-right-open', 53, '53', 'arrow', 153, '153', + 'arrow-open', 54, '54', 'arrow-wide', 154, '154', + 'arrow-wide-open'] Returns ------- diff --git a/plotly/graph_objects/violin/_meanline.py b/plotly/graph_objects/violin/_meanline.py index 50defccb42..466676b22b 100644 --- a/plotly/graph_objects/violin/_meanline.py +++ b/plotly/graph_objects/violin/_meanline.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -59,7 +60,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/violin/_selected.py b/plotly/graph_objects/violin/_selected.py index 10112cb6dc..a5eb58cd81 100644 --- a/plotly/graph_objects/violin/_selected.py +++ b/plotly/graph_objects/violin/_selected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.selected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.violin.selected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/violin/_stream.py b/plotly/graph_objects/violin/_stream.py index 9dea8017e2..b145d9f0ce 100644 --- a/plotly/graph_objects/violin/_stream.py +++ b/plotly/graph_objects/violin/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/violin/_unselected.py b/plotly/graph_objects/violin/_unselected.py index 28b587e3ae..21400fd4de 100644 --- a/plotly/graph_objects/violin/_unselected.py +++ b/plotly/graph_objects/violin/_unselected.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.violin.unselected.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.violin.unselected.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/violin/box/_line.py b/plotly/graph_objects/violin/box/_line.py index a9fab3c05c..6a369beac7 100644 --- a/plotly/graph_objects/violin/box/_line.py +++ b/plotly/graph_objects/violin/box/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/violin/hoverlabel/_font.py b/plotly/graph_objects/violin/hoverlabel/_font.py index b1e8f06226..d3516583ec 100644 --- a/plotly/graph_objects/violin/hoverlabel/_font.py +++ b/plotly/graph_objects/violin/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/violin/legendgrouptitle/_font.py b/plotly/graph_objects/violin/legendgrouptitle/_font.py index e80416b24e..3d9269f4b0 100644 --- a/plotly/graph_objects/violin/legendgrouptitle/_font.py +++ b/plotly/graph_objects/violin/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/violin/marker/_line.py b/plotly/graph_objects/violin/marker/_line.py index 6f0b432561..7342ad7547 100644 --- a/plotly/graph_objects/violin/marker/_line.py +++ b/plotly/graph_objects/violin/marker/_line.py @@ -19,11 +19,12 @@ def color(self): `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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -42,11 +43,12 @@ def outliercolor(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -65,7 +67,8 @@ def outlierwidth(self): points. The 'outlierwidth' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -83,7 +86,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/violin/selected/_marker.py b/plotly/graph_objects/violin/selected/_marker.py index 89ed733219..7f4d3418c7 100644 --- a/plotly/graph_objects/violin/selected/_marker.py +++ b/plotly/graph_objects/violin/selected/_marker.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -56,7 +58,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/violin/unselected/_marker.py b/plotly/graph_objects/violin/unselected/_marker.py index 5bb639f684..0b8a8bfa59 100644 --- a/plotly/graph_objects/violin/unselected/_marker.py +++ b/plotly/graph_objects/violin/unselected/_marker.py @@ -17,11 +17,12 @@ def color(self): 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -40,7 +41,8 @@ def opacity(self): a selection exists. The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -59,7 +61,8 @@ def size(self): selection exists. The 'size' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/volume/_caps.py b/plotly/graph_objects/volume/_caps.py index f0cbb6296c..07e3429562 100644 --- a/plotly/graph_objects/volume/_caps.py +++ b/plotly/graph_objects/volume/_caps.py @@ -15,9 +15,9 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.caps.X` - - A dict of string/value properties that will be passed - to the X constructor + + - An instance of :class:`plotly.graph_objects.volume.caps.X` + - A dict of string/value properties that will be passed to the X constructor Returns ------- @@ -34,9 +34,9 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.caps.Y` - - A dict of string/value properties that will be passed - to the Y constructor + + - An instance of :class:`plotly.graph_objects.volume.caps.Y` + - A dict of string/value properties that will be passed to the Y constructor Returns ------- @@ -53,9 +53,9 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.caps.Z` - - A dict of string/value properties that will be passed - to the Z constructor + + - An instance of :class:`plotly.graph_objects.volume.caps.Z` + - A dict of string/value properties that will be passed to the Z constructor Returns ------- diff --git a/plotly/graph_objects/volume/_colorbar.py b/plotly/graph_objects/volume/_colorbar.py index 6ad8dd6e9b..75abf6a7f7 100644 --- a/plotly/graph_objects/volume/_colorbar.py +++ b/plotly/graph_objects/volume/_colorbar.py @@ -66,11 +66,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -88,11 +89,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -110,7 +112,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -168,8 +171,10 @@ def exponentformat(self): "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'] + + - One of the following enumeration values: + + ['none', 'e', 'E', 'power', 'SI', 'B'] Returns ------- @@ -214,7 +219,8 @@ def len(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -234,8 +240,10 @@ def lenmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -254,7 +262,8 @@ def minexponent(self): has an effect when `tickformat` is "SI" or "B". The 'minexponent' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- @@ -275,7 +284,8 @@ def nticks(self): `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) + + - An int (or float that will be cast to an int) in the interval [0, 9223372036854775807] Returns @@ -294,8 +304,10 @@ def orientation(self): Sets the orientation of the colorbar. The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v'] + + - One of the following enumeration values: + + ['h', 'v'] Returns ------- @@ -313,11 +325,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -335,7 +348,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -374,8 +388,10 @@ def showexponent(self): no exponents appear. The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -414,8 +430,10 @@ def showtickprefix(self): "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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -433,8 +451,10 @@ 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'] + + - One of the following enumeration values: + + ['all', 'first', 'last', 'none'] Returns ------- @@ -453,7 +473,8 @@ def thickness(self): 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -473,8 +494,10 @@ def thicknessmode(self): "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'] + + - One of the following enumeration values: + + ['fraction', 'pixels'] Returns ------- @@ -539,11 +562,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -562,9 +586,9 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.colorbar.Tickfont` - - A dict of string/value properties that will be passed - to the Tickfont constructor + + - An instance of :class:`plotly.graph_objects.volume.colorbar.Tickfont` + - A dict of string/value properties that will be passed to the Tickfont constructor Returns ------- @@ -591,8 +615,10 @@ def tickformat(self): "%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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -609,8 +635,9 @@ 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_objects.volume.colorbar.Tickformatstop - - A list or tuple of dicts of string/value properties that + + - A list or tuple of instances of plotly.graph_objects.volume.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor Returns @@ -633,9 +660,9 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.colorbar.Tickformatstop` - - A dict of string/value properties that will be passed - to the Tickformatstop constructor + + - An instance of :class:`plotly.graph_objects.volume.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed to the Tickformatstop constructor Returns ------- @@ -656,8 +683,10 @@ def ticklabeloverflow(self): default is *hide past div*. The 'ticklabeloverflow' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['allow', 'hide past div', 'hide past domain'] + + - One of the following enumeration values: + + ['allow', 'hide past div', 'hide past domain'] Returns ------- @@ -677,10 +706,12 @@ def ticklabelposition(self): and bottom when `orientation` is "v". The 'ticklabelposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['outside', 'inside', 'outside top', 'inside top', - 'outside left', 'inside left', 'outside right', 'inside - right', 'outside bottom', 'inside bottom'] + + - One of the following enumeration values: + + ['outside', 'inside', 'outside top', 'inside top', 'outside + left', 'inside left', 'outside right', 'inside right', + 'outside bottom', 'inside bottom'] Returns ------- @@ -703,7 +734,8 @@ def ticklabelstep(self): "log" or "multicategory", or when `tickmode` is "array". The 'ticklabelstep' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -722,7 +754,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -746,8 +779,10 @@ def tickmode(self): 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'] + + - One of the following enumeration values: + + ['auto', 'linear', 'array'] Returns ------- @@ -765,8 +800,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -786,8 +823,10 @@ def ticks(self): 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', ''] + + - One of the following enumeration values: + + ['outside', 'inside', ''] Returns ------- @@ -805,8 +844,10 @@ 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -899,7 +940,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -916,9 +958,9 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.colorbar.Title` - - A dict of string/value properties that will be passed - to the Title constructor + + - An instance of :class:`plotly.graph_objects.volume.colorbar.Title` + - A dict of string/value properties that will be passed to the Title constructor Returns ------- @@ -943,7 +985,7 @@ def x(self): The 'x' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -964,8 +1006,10 @@ def xanchor(self): "center" when `orientation` is "h". The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right'] + + - One of the following enumeration values: + + ['left', 'center', 'right'] Returns ------- @@ -983,7 +1027,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1003,8 +1048,10 @@ def xref(self): plotting area only. The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- @@ -1029,7 +1076,7 @@ def y(self): The 'y' property is a number and may be specified as: - - An int or float + - An int or float Returns ------- @@ -1050,8 +1097,10 @@ def yanchor(self): and "bottom" when `orientation` is "h". The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['top', 'middle', 'bottom'] + + - One of the following enumeration values: + + ['top', 'middle', 'bottom'] Returns ------- @@ -1069,7 +1118,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- @@ -1089,8 +1139,10 @@ def yref(self): plotting area only. The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['container', 'paper'] + + - One of the following enumeration values: + + ['container', 'paper'] Returns ------- diff --git a/plotly/graph_objects/volume/_contour.py b/plotly/graph_objects/volume/_contour.py index e1cabb5851..2a83a7b113 100644 --- a/plotly/graph_objects/volume/_contour.py +++ b/plotly/graph_objects/volume/_contour.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -56,7 +57,8 @@ 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] + + - An int or float in the interval [1, 16] Returns ------- diff --git a/plotly/graph_objects/volume/_hoverlabel.py b/plotly/graph_objects/volume/_hoverlabel.py index bc5de072d5..eb93341ec5 100644 --- a/plotly/graph_objects/volume/_hoverlabel.py +++ b/plotly/graph_objects/volume/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.volume.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/volume/_legendgrouptitle.py b/plotly/graph_objects/volume/_legendgrouptitle.py index 099890dda5..0bec542894 100644 --- a/plotly/graph_objects/volume/_legendgrouptitle.py +++ b/plotly/graph_objects/volume/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.volume.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/volume/_lighting.py b/plotly/graph_objects/volume/_lighting.py index c11c440343..a942345010 100644 --- a/plotly/graph_objects/volume/_lighting.py +++ b/plotly/graph_objects/volume/_lighting.py @@ -25,7 +25,8 @@ def ambient(self): out the image. The 'ambient' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -44,7 +45,8 @@ def diffuse(self): range of angles. The 'diffuse' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -63,7 +65,8 @@ def facenormalsepsilon(self): from degenerate geometry. The 'facenormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- @@ -83,7 +86,8 @@ def fresnel(self): 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] + + - An int or float in the interval [0, 5] Returns ------- @@ -102,7 +106,8 @@ def roughness(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -121,7 +126,8 @@ def specular(self): single direction, causing shine. The 'specular' property is a number and may be specified as: - - An int or float in the interval [0, 2] + + - An int or float in the interval [0, 2] Returns ------- @@ -140,7 +146,8 @@ def vertexnormalsepsilon(self): arising from degenerate geometry. The 'vertexnormalsepsilon' property is a number and may be specified as: - - An int or float in the interval [0, 1] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/_lightposition.py b/plotly/graph_objects/volume/_lightposition.py index 80f0f4a10b..3f9ded094d 100644 --- a/plotly/graph_objects/volume/_lightposition.py +++ b/plotly/graph_objects/volume/_lightposition.py @@ -16,7 +16,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -34,7 +35,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- @@ -52,7 +54,8 @@ 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] + + - An int or float in the interval [-100000, 100000] Returns ------- diff --git a/plotly/graph_objects/volume/_slices.py b/plotly/graph_objects/volume/_slices.py index a6d58c36da..bc80c0a74a 100644 --- a/plotly/graph_objects/volume/_slices.py +++ b/plotly/graph_objects/volume/_slices.py @@ -15,9 +15,9 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.slices.X` - - A dict of string/value properties that will be passed - to the X constructor + + - An instance of :class:`plotly.graph_objects.volume.slices.X` + - A dict of string/value properties that will be passed to the X constructor Returns ------- @@ -34,9 +34,9 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.slices.Y` - - A dict of string/value properties that will be passed - to the Y constructor + + - An instance of :class:`plotly.graph_objects.volume.slices.Y` + - A dict of string/value properties that will be passed to the Y constructor Returns ------- @@ -53,9 +53,9 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.slices.Z` - - A dict of string/value properties that will be passed - to the Z constructor + + - An instance of :class:`plotly.graph_objects.volume.slices.Z` + - A dict of string/value properties that will be passed to the Z constructor Returns ------- diff --git a/plotly/graph_objects/volume/_spaceframe.py b/plotly/graph_objects/volume/_spaceframe.py index 850201305d..2eadeea47e 100644 --- a/plotly/graph_objects/volume/_spaceframe.py +++ b/plotly/graph_objects/volume/_spaceframe.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/_stream.py b/plotly/graph_objects/volume/_stream.py index 9fedc6bf58..c2f78071d1 100644 --- a/plotly/graph_objects/volume/_stream.py +++ b/plotly/graph_objects/volume/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/volume/_surface.py b/plotly/graph_objects/volume/_surface.py index 0f4c3331ea..1d71e23510 100644 --- a/plotly/graph_objects/volume/_surface.py +++ b/plotly/graph_objects/volume/_surface.py @@ -18,7 +18,8 @@ def count(self): 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) + + - An int (or float that will be cast to an int) in the interval [1, 9223372036854775807] Returns @@ -40,7 +41,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- @@ -65,7 +67,8 @@ def pattern(self): 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 + + - 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') diff --git a/plotly/graph_objects/volume/caps/_x.py b/plotly/graph_objects/volume/caps/_x.py index 714c17588a..d25c11d7c3 100644 --- a/plotly/graph_objects/volume/caps/_x.py +++ b/plotly/graph_objects/volume/caps/_x.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/caps/_y.py b/plotly/graph_objects/volume/caps/_y.py index 4a56ff0635..b0a8570383 100644 --- a/plotly/graph_objects/volume/caps/_y.py +++ b/plotly/graph_objects/volume/caps/_y.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/caps/_z.py b/plotly/graph_objects/volume/caps/_z.py index de7072762b..f8b3b96693 100644 --- a/plotly/graph_objects/volume/caps/_z.py +++ b/plotly/graph_objects/volume/caps/_z.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/colorbar/_tickfont.py b/plotly/graph_objects/volume/colorbar/_tickfont.py index 7f20927717..63556883d3 100644 --- a/plotly/graph_objects/volume/colorbar/_tickfont.py +++ b/plotly/graph_objects/volume/colorbar/_tickfont.py @@ -24,11 +24,12 @@ class Tickfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/volume/colorbar/_tickformatstop.py b/plotly/graph_objects/volume/colorbar/_tickformatstop.py index 5769032259..b61296bf34 100644 --- a/plotly/graph_objects/volume/colorbar/_tickformatstop.py +++ b/plotly/graph_objects/volume/colorbar/_tickformatstop.py @@ -66,8 +66,10 @@ def name(self): template. The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -92,8 +94,10 @@ def templateitemname(self): 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 + + - A string + + - A number that will be converted to a string Returns ------- @@ -112,8 +116,10 @@ def value(self): "tickformat" The 'value' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/volume/colorbar/_title.py b/plotly/graph_objects/volume/colorbar/_title.py index 8bbb6185de..4c64da503d 100644 --- a/plotly/graph_objects/volume/colorbar/_title.py +++ b/plotly/graph_objects/volume/colorbar/_title.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.volume.colorbar.title.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.volume.colorbar.title.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -39,8 +39,10 @@ def side(self): defaults to "right" when `orientation` if "h". The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] + + - One of the following enumeration values: + + ['right', 'top', 'bottom'] Returns ------- @@ -58,8 +60,10 @@ def text(self): Sets the title of the color bar. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/volume/colorbar/title/_font.py b/plotly/graph_objects/volume/colorbar/title/_font.py index f047fb52ed..2efd91f00f 100644 --- a/plotly/graph_objects/volume/colorbar/title/_font.py +++ b/plotly/graph_objects/volume/colorbar/title/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/volume/hoverlabel/_font.py b/plotly/graph_objects/volume/hoverlabel/_font.py index dceca5fff1..b0391cbf8f 100644 --- a/plotly/graph_objects/volume/hoverlabel/_font.py +++ b/plotly/graph_objects/volume/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/volume/legendgrouptitle/_font.py b/plotly/graph_objects/volume/legendgrouptitle/_font.py index a3dd830597..fcc633955a 100644 --- a/plotly/graph_objects/volume/legendgrouptitle/_font.py +++ b/plotly/graph_objects/volume/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/volume/slices/_x.py b/plotly/graph_objects/volume/slices/_x.py index f7b703636a..74f81ddaea 100644 --- a/plotly/graph_objects/volume/slices/_x.py +++ b/plotly/graph_objects/volume/slices/_x.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/slices/_y.py b/plotly/graph_objects/volume/slices/_y.py index 07d7b49c97..f0d4bc3b10 100644 --- a/plotly/graph_objects/volume/slices/_y.py +++ b/plotly/graph_objects/volume/slices/_y.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/volume/slices/_z.py b/plotly/graph_objects/volume/slices/_z.py index 3117404b62..b0bf0cbca7 100644 --- a/plotly/graph_objects/volume/slices/_z.py +++ b/plotly/graph_objects/volume/slices/_z.py @@ -19,7 +19,8 @@ def fill(self): 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] + + - An int or float in the interval [0, 1] Returns ------- diff --git a/plotly/graph_objects/waterfall/_connector.py b/plotly/graph_objects/waterfall/_connector.py index a76c69fb9e..5995a15dc3 100644 --- a/plotly/graph_objects/waterfall/_connector.py +++ b/plotly/graph_objects/waterfall/_connector.py @@ -15,9 +15,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.connector.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.waterfall.connector.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- @@ -35,8 +35,10 @@ def mode(self): Sets the shape of connector lines. The 'mode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['spanning', 'between'] + + - One of the following enumeration values: + + ['spanning', 'between'] Returns ------- diff --git a/plotly/graph_objects/waterfall/_decreasing.py b/plotly/graph_objects/waterfall/_decreasing.py index b1445a3b84..bb32f3c4c3 100644 --- a/plotly/graph_objects/waterfall/_decreasing.py +++ b/plotly/graph_objects/waterfall/_decreasing.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.decreasing.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.waterfall.decreasing.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/waterfall/_hoverlabel.py b/plotly/graph_objects/waterfall/_hoverlabel.py index 8d3af23054..24f2fb6097 100644 --- a/plotly/graph_objects/waterfall/_hoverlabel.py +++ b/plotly/graph_objects/waterfall/_hoverlabel.py @@ -28,9 +28,12 @@ def align(self): more two or more lines The 'align' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'auto'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['left', 'right', 'auto'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -66,12 +69,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -107,12 +111,13 @@ 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: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -150,9 +155,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.hoverlabel.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.waterfall.hoverlabel.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -175,7 +180,8 @@ def namelength(self): `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) + + - 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 diff --git a/plotly/graph_objects/waterfall/_increasing.py b/plotly/graph_objects/waterfall/_increasing.py index 9fc7a4c58b..1f6ef912c4 100644 --- a/plotly/graph_objects/waterfall/_increasing.py +++ b/plotly/graph_objects/waterfall/_increasing.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.increasing.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.waterfall.increasing.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/waterfall/_insidetextfont.py b/plotly/graph_objects/waterfall/_insidetextfont.py index 9e97dc0662..26aa6f5775 100644 --- a/plotly/graph_objects/waterfall/_insidetextfont.py +++ b/plotly/graph_objects/waterfall/_insidetextfont.py @@ -33,12 +33,13 @@ class Insidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/waterfall/_legendgrouptitle.py b/plotly/graph_objects/waterfall/_legendgrouptitle.py index 0236e40eda..c7c5c7d747 100644 --- a/plotly/graph_objects/waterfall/_legendgrouptitle.py +++ b/plotly/graph_objects/waterfall/_legendgrouptitle.py @@ -17,9 +17,9 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.legendgrouptitle.Font` - - A dict of string/value properties that will be passed - to the Font constructor + + - An instance of :class:`plotly.graph_objects.waterfall.legendgrouptitle.Font` + - A dict of string/value properties that will be passed to the Font constructor Returns ------- @@ -37,8 +37,10 @@ def text(self): Sets the title of the legend group. The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- diff --git a/plotly/graph_objects/waterfall/_outsidetextfont.py b/plotly/graph_objects/waterfall/_outsidetextfont.py index abe8fee90b..5bcd57790b 100644 --- a/plotly/graph_objects/waterfall/_outsidetextfont.py +++ b/plotly/graph_objects/waterfall/_outsidetextfont.py @@ -33,12 +33,13 @@ class Outsidetextfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/waterfall/_stream.py b/plotly/graph_objects/waterfall/_stream.py index 9d9ec7685d..ca646ea94c 100644 --- a/plotly/graph_objects/waterfall/_stream.py +++ b/plotly/graph_objects/waterfall/_stream.py @@ -18,7 +18,8 @@ def maxpoints(self): 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] + + - An int or float in the interval [0, 10000] Returns ------- @@ -38,7 +39,8 @@ def token(self): details. The 'token' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- diff --git a/plotly/graph_objects/waterfall/_textfont.py b/plotly/graph_objects/waterfall/_textfont.py index 27c9e2e52c..f73369e952 100644 --- a/plotly/graph_objects/waterfall/_textfont.py +++ b/plotly/graph_objects/waterfall/_textfont.py @@ -33,12 +33,13 @@ class Textfont(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/waterfall/_totals.py b/plotly/graph_objects/waterfall/_totals.py index bc4acf2728..2bc105ce16 100644 --- a/plotly/graph_objects/waterfall/_totals.py +++ b/plotly/graph_objects/waterfall/_totals.py @@ -15,9 +15,9 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.totals.Marker` - - A dict of string/value properties that will be passed - to the Marker constructor + + - An instance of :class:`plotly.graph_objects.waterfall.totals.Marker` + - A dict of string/value properties that will be passed to the Marker constructor Returns ------- diff --git a/plotly/graph_objects/waterfall/connector/_line.py b/plotly/graph_objects/waterfall/connector/_line.py index 12acc20057..fae63dc902 100644 --- a/plotly/graph_objects/waterfall/connector/_line.py +++ b/plotly/graph_objects/waterfall/connector/_line.py @@ -16,11 +16,12 @@ 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: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -41,10 +42,14 @@ def dash(self): "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.) + + - 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 ------- @@ -62,7 +67,8 @@ 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] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/waterfall/decreasing/_marker.py b/plotly/graph_objects/waterfall/decreasing/_marker.py index 2ae5a15aa9..ef78c4f2e7 100644 --- a/plotly/graph_objects/waterfall/decreasing/_marker.py +++ b/plotly/graph_objects/waterfall/decreasing/_marker.py @@ -16,11 +16,12 @@ def color(self): Sets the marker color of all decreasing values. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.decreasing.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.waterfall.decreasing.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/waterfall/decreasing/marker/_line.py b/plotly/graph_objects/waterfall/decreasing/marker/_line.py index 33a4fa50d0..9109918ba8 100644 --- a/plotly/graph_objects/waterfall/decreasing/marker/_line.py +++ b/plotly/graph_objects/waterfall/decreasing/marker/_line.py @@ -16,11 +16,12 @@ def color(self): Sets the line color of all decreasing values. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ def width(self): Sets the line width of all decreasing values. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/waterfall/hoverlabel/_font.py b/plotly/graph_objects/waterfall/hoverlabel/_font.py index 6539976b36..52bc519917 100644 --- a/plotly/graph_objects/waterfall/hoverlabel/_font.py +++ b/plotly/graph_objects/waterfall/hoverlabel/_font.py @@ -33,12 +33,13 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list - - A list or array of any of the above + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above Returns ------- @@ -78,8 +79,10 @@ def family(self): to apply fonts if they aren't available. 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 + + - A non-empty string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -118,10 +121,11 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') - - A list or array of the above + - A list or array of the above Returns ------- @@ -161,9 +165,12 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above + + - A string + + - A number that will be converted to a string + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -197,8 +204,10 @@ def shadowsrc(self, val): 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 + + - An int or float in the interval [1, inf] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -235,9 +244,12 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'italic'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -275,9 +287,12 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -313,10 +328,13 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] - - A tuple, list, or one-dimensional numpy array of the above + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] + + - A tuple, list, or one-dimensional numpy array of the above Returns ------- @@ -352,7 +370,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') - A tuple, list, or one-dimensional numpy array of the above diff --git a/plotly/graph_objects/waterfall/increasing/_marker.py b/plotly/graph_objects/waterfall/increasing/_marker.py index f48182701b..76f1444ad1 100644 --- a/plotly/graph_objects/waterfall/increasing/_marker.py +++ b/plotly/graph_objects/waterfall/increasing/_marker.py @@ -16,11 +16,12 @@ def color(self): Sets the marker color of all increasing values. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -37,9 +38,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.increasing.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.waterfall.increasing.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/waterfall/increasing/marker/_line.py b/plotly/graph_objects/waterfall/increasing/marker/_line.py index 263b9269fa..3d73c752ca 100644 --- a/plotly/graph_objects/waterfall/increasing/marker/_line.py +++ b/plotly/graph_objects/waterfall/increasing/marker/_line.py @@ -16,11 +16,12 @@ def color(self): Sets the line color of all increasing values. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ def width(self): Sets the line width of all increasing values. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/graph_objects/waterfall/legendgrouptitle/_font.py b/plotly/graph_objects/waterfall/legendgrouptitle/_font.py index efc8adad6c..b0e627bf7b 100644 --- a/plotly/graph_objects/waterfall/legendgrouptitle/_font.py +++ b/plotly/graph_objects/waterfall/legendgrouptitle/_font.py @@ -24,11 +24,12 @@ class Font(_BaseTraceHierarchyType): def color(self): """ The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -50,7 +51,8 @@ def family(self): to apply fonts if they aren't available. The 'family' property is a string and must be specified as: - - A non-empty string + + - A non-empty string Returns ------- @@ -71,7 +73,8 @@ def lineposition(self): The 'lineposition' property is a flaglist and may be specified as a string containing: - - Any combination of ['under', 'over', 'through'] joined with '+' characters + + - Any combination of ['under', 'over', 'through'] joined with '+' characters (e.g. 'under+over') OR exactly one of ['none'] (e.g. 'none') @@ -94,8 +97,10 @@ def shadow(self): for additional options. The 'shadow' property is a string and must be specified as: - - A string - - A number that will be converted to a string + + - A string + + - A number that will be converted to a string Returns ------- @@ -111,7 +116,8 @@ def shadow(self, val): def size(self): """ The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] + + - An int or float in the interval [1, inf] Returns ------- @@ -130,8 +136,10 @@ def style(self): face from its family. The 'style' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'italic'] + + - One of the following enumeration values: + + ['normal', 'italic'] Returns ------- @@ -151,8 +159,10 @@ def textcase(self): capitalized. The 'textcase' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'word caps', 'upper', 'lower'] + + - One of the following enumeration values: + + ['normal', 'word caps', 'upper', 'lower'] Returns ------- @@ -170,9 +180,11 @@ def variant(self): Sets the variant of the font. The 'variant' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'small-caps', 'all-small-caps', - 'all-petite-caps', 'petite-caps', 'unicase'] + + - One of the following enumeration values: + + ['normal', 'small-caps', 'all-small-caps', 'all-petite-caps', + 'petite-caps', 'unicase'] Returns ------- @@ -190,7 +202,8 @@ def weight(self): Sets the weight (or boldness) of the font. The 'weight' property is a integer and may be specified as: - - An int (or float that will be cast to an int) + + - An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of ['normal', 'bold'] (e.g. 'bold') diff --git a/plotly/graph_objects/waterfall/totals/_marker.py b/plotly/graph_objects/waterfall/totals/_marker.py index bd82f57b80..09c1b1183b 100644 --- a/plotly/graph_objects/waterfall/totals/_marker.py +++ b/plotly/graph_objects/waterfall/totals/_marker.py @@ -17,11 +17,12 @@ def color(self): values. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,9 +39,9 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of :class:`plotly.graph_objects.waterfall.totals.marker.Line` - - A dict of string/value properties that will be passed - to the Line constructor + + - An instance of :class:`plotly.graph_objects.waterfall.totals.marker.Line` + - A dict of string/value properties that will be passed to the Line constructor Returns ------- diff --git a/plotly/graph_objects/waterfall/totals/marker/_line.py b/plotly/graph_objects/waterfall/totals/marker/_line.py index 2acc4590bc..1f220a01ff 100644 --- a/plotly/graph_objects/waterfall/totals/marker/_line.py +++ b/plotly/graph_objects/waterfall/totals/marker/_line.py @@ -16,11 +16,12 @@ def color(self): Sets the line color of all intermediate sums and total values. The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list Returns ------- @@ -38,7 +39,8 @@ def width(self): Sets the line width of all intermediate sums and total values. The 'width' property is a number and may be specified as: - - An int or float in the interval [0, inf] + + - An int or float in the interval [0, inf] Returns ------- diff --git a/plotly/io/_json.py b/plotly/io/_json.py index 157240a748..ea84393822 100644 --- a/plotly/io/_json.py +++ b/plotly/io/_json.py @@ -90,10 +90,11 @@ def to_json_plotly(plotly_object, pretty=False, engine=None): representation should be as compact as possible. engine: str (default None) - The JSON encoding engine to use. One of: - - "json" for an engine based on the built-in Python json module - - "orjson" for a faster engine that requires the orjson package - - "auto" for the "orjson" engine if available, otherwise "json" + The JSON encoding engine to use. One of:\n + - "json" for an engine based on the built-in Python json module + - "orjson" for a faster engine that requires the orjson package + - "auto" for the "orjson" engine if available, otherwise "json" + If not specified, the default engine is set to the current value of plotly.io.json.config.default_engine. @@ -193,10 +194,11 @@ def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None): True if trace UIDs should be omitted from the JSON representation engine: str (default None) - The JSON encoding engine to use. One of: - - "json" for an engine based on the built-in Python json module - - "orjson" for a faster engine that requires the orjson package - - "auto" for the "orjson" engine if available, otherwise "json" + The JSON encoding engine to use. One of:\n + - "json" for an engine based on the built-in Python json module + - "orjson" for a faster engine that requires the orjson package + - "auto" for the "orjson" engine if available, otherwise "json" + If not specified, the default engine is set to the current value of plotly.io.json.config.default_engine. @@ -244,10 +246,11 @@ def write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine= True if trace UIDs should be omitted from the JSON representation engine: str (default None) - The JSON encoding engine to use. One of: - - "json" for an engine based on the built-in Python json module - - "orjson" for a faster engine that requires the orjson package - - "auto" for the "orjson" engine if available, otherwise "json" + The JSON encoding engine to use. One of:\n + - "json" for an engine based on the built-in Python json module + - "orjson" for a faster engine that requires the orjson package + - "auto" for the "orjson" engine if available, otherwise "json" + If not specified, the default engine is set to the current value of plotly.io.json.config.default_engine. Returns @@ -306,11 +309,11 @@ def from_json_plotly(value, engine=None): A JSON string or bytes object engine: str (default None) - The JSON decoding engine to use. One of: - - if "json", parse JSON using built in json module - - if "orjson", parse using the faster orjson module, requires the orjson + The JSON decoding engine to use. One of:\n + - if "json", parse JSON using built in json module + - if "orjson", parse using the faster orjson module, requires the orjson package - - if "auto" use orjson module if available, otherwise use the json module + - if "auto" use orjson module if available, otherwise use the json module If not specified, the default engine is set to the current value of plotly.io.json.config.default_engine. @@ -377,11 +380,11 @@ def from_json(value, output_type="Figure", skip_invalid=False, engine=None): True if invalid figure properties should be silently ignored. engine: str (default None) - The JSON decoding engine to use. One of: - - if "json", parse JSON using built in json module - - if "orjson", parse using the faster orjson module, requires the orjson + The JSON decoding engine to use. One of:\n + - if "json", parse JSON using built in json module + - if "orjson", parse using the faster orjson module, requires the orjson package - - if "auto" use orjson module if available, otherwise use the json module + - if "auto" use orjson module if available, otherwise use the json module If not specified, the default engine is set to the current value of plotly.io.json.config.default_engine. @@ -419,8 +422,8 @@ def read_json(file, output_type="Figure", skip_invalid=False, engine=None): Parameters ---------- file: str or readable - A string containing the path to a local file or a read-able Python - object (e.g. a pathlib.Path object or an open file descriptor) + A string containing the path to a local file or a read-able Python + object (e.g. a pathlib.Path object or an open file descriptor) output_type: type or str (default 'Figure') The output figure type or type name. @@ -431,11 +434,11 @@ def read_json(file, output_type="Figure", skip_invalid=False, engine=None): True if invalid figure properties should be silently ignored. engine: str (default None) - The JSON decoding engine to use. One of: - - if "json", parse JSON using built in json module - - if "orjson", parse using the faster orjson module, requires the orjson + The JSON decoding engine to use. One of:\n + - if "json", parse JSON using built in json module + - if "orjson", parse using the faster orjson module, requires the orjson package - - if "auto" use orjson module if available, otherwise use the json module + - if "auto" use orjson module if available, otherwise use the json module If not specified, the default engine is set to the current value of plotly.io.json.config.default_engine. diff --git a/plotly/io/_renderers.py b/plotly/io/_renderers.py index 9ddd1db5dd..dd103f047b 100644 --- a/plotly/io/_renderers.py +++ b/plotly/io/_renderers.py @@ -147,13 +147,17 @@ def default(self): '+' characters. For example, to specify rendering compatible with the classic Jupyter Notebook, JupyterLab, and PDF export: + ``` >>> import plotly.io as pio >>> pio.renderers.default = 'notebook+jupyterlab+pdf' + ``` The names of available renderers may be retrieved with: + ``` >>> import plotly.io as pio >>> list(pio.renderers) + ``` Returns ------- @@ -373,27 +377,27 @@ def show(fig, renderer=None, validate=True, **kwargs): Parameters ---------- - fig: dict of Figure + fig : dict of Figure The Figure object or figure dict to display - renderer: str or None (default None) + renderer : str or None (default None) A string containing the names of one or more registered renderers (separated by '+' characters) or None. If None, then the default renderers specified in plotly.io.renderers.default are used. - validate: bool (default True) + validate : bool (default True) True if the figure should be validated before being shown, False otherwise. - width: int or float + width : int or float An integer or float that determines the number of pixels wide the plot is. The default is set in plotly.js. - height: int or float + height : int or float An integer or float specifying the height of the plot in pixels. The default is set in plotly.js. - config: dict + config : dict A dict of parameters to configure the figure. The defaults are set in plotly.js.