diff --git a/.circleci/config.yml b/.circleci/config.yml index b02e989c310..7c90978fe1a 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -409,7 +409,7 @@ jobs: cd ../../../doc fi echo 'export PATH="/home/circleci/project/doc/node_modules/.bin:$PATH"' >> $BASH_ENV - sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 + sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename cd .. - save_cache: diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index 8b64b1e99ec..1c39b0eb4e8 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -15,5 +15,10 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +# For sphinx-apidoc the first positional path is the module to document +# then all the other ones are paths to exclude for the doc generation %: Makefile + sphinx-apidoc -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html + sed -i 's/graph_objs/graph_objects/g' _build/html/*.html _build/html/generated/*.html diff --git a/doc/apidoc/_templates/class.rst b/doc/apidoc/_templates/class.rst deleted file mode 100644 index 494293e1cbc..00000000000 --- a/doc/apidoc/_templates/class.rst +++ /dev/null @@ -1,15 +0,0 @@ -:mod:`{{module}}`.{{objname}} -{{ underline }}============== - -.. currentmodule:: {{ module }} - -.. autoclass:: {{ objname }} - - {% block methods %} - .. automethod:: __init__ - {% endblock %} - - -.. raw:: html - -
diff --git a/doc/apidoc/_templates/trace.rst b/doc/apidoc/_templates/trace.rst index 6bd81c0196f..44b33fc4d12 100644 --- a/doc/apidoc/_templates/trace.rst +++ b/doc/apidoc/_templates/trace.rst @@ -10,7 +10,6 @@ .. automethod:: __init__ {% endblock %} - :mod:`{{module}}`.{{objname.lower()}} {{ underline }}================================ @@ -20,6 +19,7 @@ .. automodule:: plotly.graph_objects.{{ objname.lower() }} :members: + :undoc-members: .. raw:: html diff --git a/doc/apidoc/plotly.graph_objects.rst b/doc/apidoc/plotly.graph_objects.rst index 185dfd6fee6..cadf75e089c 100644 --- a/doc/apidoc/plotly.graph_objects.rst +++ b/doc/apidoc/plotly.graph_objects.rst @@ -3,7 +3,7 @@ `plotly.graph_objects`: low-level interface to figures, traces and layout ========================================= -.. currentmodule:: plotly.graph_objects +.. currentmodule:: plotly.graph_objs :mod:`plotly.graph_objects` contains the building blocks of plotly :class:`Figure`: traces (:class:`Scatter`, :class:`Bar`, ...) and :class:`Layout` @@ -31,7 +31,6 @@ Layout Layout - Simple charts -------------- diff --git a/packages/javascript/plotlywidget/package-lock.json b/packages/javascript/plotlywidget/package-lock.json index 6273fc79f85..efc8f8d6b6a 100644 --- a/packages/javascript/plotlywidget/package-lock.json +++ b/packages/javascript/plotlywidget/package-lock.json @@ -2236,8 +2236,8 @@ "dev": true, "optional": true, "requires": { - "co": "4.6.0", - "json-stable-stringify": "1.0.1" + "co": "^4.6.0", + "json-stable-stringify": "^1.0.1" } }, "ansi-regex": { diff --git a/packages/python/plotly/_plotly_utils/basevalidators.py b/packages/python/plotly/_plotly_utils/basevalidators.py index 32e06fd63ea..452164bd2cd 100644 --- a/packages/python/plotly/_plotly_utils/basevalidators.py +++ b/packages/python/plotly/_plotly_utils/basevalidators.py @@ -2421,7 +2421,7 @@ def description(self): """\ The '{plotly_name}' property is an instance of {class_str} that may be specified as: - - An instance of {module_str}.{class_str} + - An instance of :class:`{module_str}.{class_str}` - A dict of string/value properties that will be passed to the {class_str} constructor diff --git a/packages/python/plotly/codegen/datatypes.py b/packages/python/plotly/codegen/datatypes.py index 19e7edef2c9..fa25dae0027 100644 --- a/packages/python/plotly/codegen/datatypes.py +++ b/packages/python/plotly/codegen/datatypes.py @@ -293,7 +293,7 @@ def __init__(self""" ( f"arg", f"dict of properties compatible with this constructor " - f"or an instance of {class_name}", + f"or an instance of :class:`{class_name}`", ) ] @@ -321,7 +321,7 @@ def __init__(self""" raise ValueError(\"\"\"\\ The first argument to the {class_name} constructor must be a dict or -an instance of {class_name}\"\"\") +an instance of :class:`{class_name}`\"\"\") # Handle skip_invalid # ------------------- diff --git a/packages/python/plotly/codegen/figure.py b/packages/python/plotly/codegen/figure.py index 6c5d98fdf98..14ef22faf08 100644 --- a/packages/python/plotly/codegen/figure.py +++ b/packages/python/plotly/codegen/figure.py @@ -94,7 +94,7 @@ class {fig_classname}({base_classname}):\n""" def __init__(self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs): \"\"\" - Create a new {fig_classname} instance + Create a new :class:{fig_classname} instance Parameters ---------- diff --git a/packages/python/plotly/codegen/utils.py b/packages/python/plotly/codegen/utils.py index ff950d60117..9c000fa70b0 100644 --- a/packages/python/plotly/codegen/utils.py +++ b/packages/python/plotly/codegen/utils.py @@ -941,7 +941,7 @@ def get_constructor_params_docstring(self, indent=12): f"{subtype_node.name_datatype_class}" ) subtype_description = ( - f"A tuple of {class_name} instances or " + f"A tuple of :class:`{class_name}` instances or " "dicts with compatible properties" ) elif subtype_node.is_compound: @@ -958,7 +958,7 @@ def get_constructor_params_docstring(self, indent=12): ) subtype_description = ( - f"{class_name} instance or dict with compatible properties" + f":class:`{class_name}` instance or dict with compatible properties" ) else: subtype_description = "" diff --git a/packages/python/plotly/plotly/express/_doc.py b/packages/python/plotly/plotly/express/_doc.py index 3b153b0587a..b71d1e40447 100644 --- a/packages/python/plotly/plotly/express/_doc.py +++ b/packages/python/plotly/plotly/express/_doc.py @@ -536,5 +536,5 @@ def make_docstring(fn, override_dict={}): param_type = param_doc[0] result += "%s: %s\n%s\n" % (param, param_type, param_desc) result += "\nReturns\n-------\n" - result += " A `Figure` object." + result += " plotly.graph_objects.Figure" return result diff --git a/packages/python/plotly/plotly/graph_objs/__init__.py b/packages/python/plotly/plotly/graph_objs/__init__.py index ee0cde75f81..ff488db3ec0 100644 --- a/packages/python/plotly/plotly/graph_objs/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/__init__.py @@ -77,15 +77,16 @@ def connector(self): """ The 'connector' property is an instance of Connector that may be specified as: - - An instance of plotly.graph_objs.waterfall.Connector + - An instance of :class:`plotly.graph_objs.waterfall.Connector` - A dict of string/value properties that will be passed to the Connector constructor Supported dict properties: line - plotly.graph_objects.waterfall.connector.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.connecto + r.Line` instance or dict with compatible + properties mode Sets the shape of connector lines. visible @@ -173,15 +174,16 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of plotly.graph_objs.waterfall.Decreasing + - An instance of :class:`plotly.graph_objs.waterfall.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor Supported dict properties: marker - plotly.graph_objects.waterfall.decreasing.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.decreasi + ng.Marker` instance or dict with compatible + properties Returns ------- @@ -286,7 +288,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.waterfall.Hoverlabel + - An instance of :class:`plotly.graph_objs.waterfall.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -494,15 +496,16 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of plotly.graph_objs.waterfall.Increasing + - An instance of :class:`plotly.graph_objs.waterfall.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor Supported dict properties: marker - plotly.graph_objects.waterfall.increasing.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.increasi + ng.Marker` instance or dict with compatible + properties Returns ------- @@ -545,7 +548,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.waterfall.Insidetextfont + - An instance of :class:`plotly.graph_objs.waterfall.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -845,7 +848,7 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of plotly.graph_objs.waterfall.Outsidetextfont + - An instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor @@ -943,7 +946,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.waterfall.Stream + - An instance of :class:`plotly.graph_objs.waterfall.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -1030,7 +1033,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.waterfall.Textfont + - An instance of :class:`plotly.graph_objs.waterfall.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -1231,15 +1234,16 @@ def totals(self): """ The 'totals' property is an instance of Totals that may be specified as: - - An instance of plotly.graph_objs.waterfall.Totals + - An instance of :class:`plotly.graph_objs.waterfall.Totals` - A dict of string/value properties that will be passed to the Totals constructor Supported dict properties: marker - plotly.graph_objects.waterfall.totals.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.M + arker` instance or dict with compatible + properties Returns ------- @@ -1573,8 +1577,8 @@ def _prop_descriptions(self): and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.waterfall.Connector instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -1586,8 +1590,8 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.waterfall.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. dy @@ -1600,8 +1604,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.waterfall.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -1645,8 +1649,8 @@ def _prop_descriptions(self): idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.waterfall.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. @@ -1712,8 +1716,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.waterfall.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -1769,8 +1773,8 @@ def _prop_descriptions(self): Sets the source reference on plot.ly for texttemplate . totals - plotly.graph_objects.waterfall.Totals instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -1909,7 +1913,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Waterfall + an instance of :class:`plotly.graph_objs.Waterfall` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls @@ -1924,8 +1928,8 @@ def __init__( and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.waterfall.Connector instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -1937,8 +1941,8 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.waterfall.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. dy @@ -1951,8 +1955,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.waterfall.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -1996,8 +2000,8 @@ def __init__( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.waterfall.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. @@ -2063,8 +2067,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.waterfall.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -2120,8 +2124,8 @@ def __init__( Sets the source reference on plot.ly for texttemplate . totals - plotly.graph_objects.waterfall.Totals instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -2199,7 +2203,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Waterfall constructor must be a dict or -an instance of plotly.graph_objs.Waterfall""" +an instance of :class:`plotly.graph_objs.Waterfall`""" ) # Handle skip_invalid @@ -2457,21 +2461,21 @@ def caps(self): """ The 'caps' property is an instance of Caps that may be specified as: - - An instance of plotly.graph_objs.volume.Caps + - An instance of :class:`plotly.graph_objs.volume.Caps` - A dict of string/value properties that will be passed to the Caps constructor Supported dict properties: x - plotly.graph_objects.volume.caps.X instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.caps.X` + instance or dict with compatible properties y - plotly.graph_objects.volume.caps.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.caps.Y` + instance or dict with compatible properties z - plotly.graph_objects.volume.caps.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.caps.Z` + instance or dict with compatible properties Returns ------- @@ -2604,7 +2608,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.volume.ColorBar + - An instance of :class:`plotly.graph_objs.volume.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -2736,9 +2740,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.volume.colorbar - .Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.volume. + colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.volume.colorbar.tickformatstopdefaults), sets @@ -2784,8 +2788,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.volume.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.volume.colorbar.Ti + tle` instance or dict with compatible + properties titlefont Deprecated: Please use volume.colorbar.title.font instead. Sets this @@ -2890,7 +2895,7 @@ def contour(self): """ The 'contour' property is an instance of Contour that may be specified as: - - An instance of plotly.graph_objs.volume.Contour + - An instance of :class:`plotly.graph_objs.volume.Contour` - A dict of string/value properties that will be passed to the Contour constructor @@ -3032,7 +3037,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.volume.Hoverlabel + - An instance of :class:`plotly.graph_objs.volume.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -3299,7 +3304,7 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of plotly.graph_objs.volume.Lighting + - An instance of :class:`plotly.graph_objs.volume.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor @@ -3347,7 +3352,7 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of plotly.graph_objs.volume.Lightposition + - An instance of :class:`plotly.graph_objs.volume.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor @@ -3591,21 +3596,21 @@ def slices(self): """ The 'slices' property is an instance of Slices that may be specified as: - - An instance of plotly.graph_objs.volume.Slices + - An instance of :class:`plotly.graph_objs.volume.Slices` - A dict of string/value properties that will be passed to the Slices constructor Supported dict properties: x - plotly.graph_objects.volume.slices.X instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.slices.X` + instance or dict with compatible properties y - plotly.graph_objects.volume.slices.Y instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.slices.Y` + instance or dict with compatible properties z - plotly.graph_objects.volume.slices.Z instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.slices.Z` + instance or dict with compatible properties Returns ------- @@ -3624,7 +3629,7 @@ def spaceframe(self): """ The 'spaceframe' property is an instance of Spaceframe that may be specified as: - - An instance of plotly.graph_objs.volume.Spaceframe + - An instance of :class:`plotly.graph_objs.volume.Spaceframe` - A dict of string/value properties that will be passed to the Spaceframe constructor @@ -3659,7 +3664,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.volume.Stream + - An instance of :class:`plotly.graph_objs.volume.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -3692,7 +3697,7 @@ def surface(self): """ The 'surface' property is an instance of Surface that may be specified as: - - An instance of plotly.graph_objs.volume.Surface + - An instance of :class:`plotly.graph_objs.volume.Surface` - A dict of string/value properties that will be passed to the Surface constructor @@ -4042,8 +4047,8 @@ def _prop_descriptions(self): chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.volume.Caps instance or dict with - compatible properties + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -4070,8 +4075,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.volume.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -4085,8 +4090,8 @@ def _prop_descriptions(self): d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.volume.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -4106,8 +4111,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.volume.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -4153,11 +4158,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.volume.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.volume.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -4212,17 +4217,17 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.volume.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties spaceframe - plotly.graph_objects.volume.Spaceframe instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.volume.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties surface - plotly.graph_objects.volume.Surface instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -4347,7 +4352,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Volume + an instance of :class:`plotly.graph_objs.Volume` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -4356,8 +4361,8 @@ def __init__( chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.volume.Caps instance or dict with - compatible properties + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -4384,8 +4389,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.volume.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -4399,8 +4404,8 @@ def __init__( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.volume.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -4420,8 +4425,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.volume.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -4467,11 +4472,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.volume.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.volume.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -4526,17 +4531,17 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.volume.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties spaceframe - plotly.graph_objects.volume.Spaceframe instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.volume.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties surface - plotly.graph_objects.volume.Surface instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -4607,7 +4612,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Volume constructor must be a dict or -an instance of plotly.graph_objs.Volume""" +an instance of :class:`plotly.graph_objs.Volume`""" ) # Handle skip_invalid @@ -4862,7 +4867,7 @@ def box(self): """ The 'box' property is an instance of Box that may be specified as: - - An instance of plotly.graph_objs.violin.Box + - An instance of :class:`plotly.graph_objs.violin.Box` - A dict of string/value properties that will be passed to the Box constructor @@ -4871,8 +4876,8 @@ def box(self): fillcolor Sets the inner box plot fill color. line - plotly.graph_objects.violin.box.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.box.Line` + instance or dict with compatible properties visible Determines if an miniature box plot is drawn inside the violins. @@ -5048,7 +5053,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.violin.Hoverlabel + - An instance of :class:`plotly.graph_objs.violin.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -5323,7 +5328,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.violin.Line + - An instance of :class:`plotly.graph_objs.violin.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -5352,7 +5357,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.violin.Marker + - An instance of :class:`plotly.graph_objs.violin.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -5365,8 +5370,8 @@ def marker(self): and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.violin.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.violin.marker.Line + ` instance or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -5398,7 +5403,7 @@ def meanline(self): """ The 'meanline' property is an instance of Meanline that may be specified as: - - An instance of plotly.graph_objs.violin.Meanline + - An instance of :class:`plotly.graph_objs.violin.Meanline` - A dict of string/value properties that will be passed to the Meanline constructor @@ -5675,15 +5680,16 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.violin.Selected + - An instance of :class:`plotly.graph_objs.violin.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.violin.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.violin.selected.Ma + rker` instance or dict with compatible + properties Returns ------- @@ -5823,7 +5829,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.violin.Stream + - An instance of :class:`plotly.graph_objs.violin.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -5957,15 +5963,16 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.violin.Unselected + - An instance of :class:`plotly.graph_objs.violin.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.violin.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.violin.unselected. + Marker` instance or dict with compatible + properties Returns ------- @@ -6223,8 +6230,8 @@ def _prop_descriptions(self): estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box - plotly.graph_objects.violin.Box instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -6244,8 +6251,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.violin.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density estimate or any @@ -6296,14 +6303,14 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.violin.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties marker - plotly.graph_objects.violin.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties meanline - plotly.graph_objects.violin.Meanline instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -6368,8 +6375,8 @@ def _prop_descriptions(self): width*count* means the violins are scaled by the number of sample points makingup each violin. selected - plotly.graph_objects.violin.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -6400,8 +6407,8 @@ def _prop_descriptions(self): settings, use mode "manual" and fill in the `span` attribute. stream - plotly.graph_objects.violin.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -6434,8 +6441,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.violin.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -6548,7 +6555,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Violin + an instance of :class:`plotly.graph_objs.Violin` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls @@ -6559,8 +6566,8 @@ def __init__( estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box - plotly.graph_objects.violin.Box instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -6580,8 +6587,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.violin.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density estimate or any @@ -6632,14 +6639,14 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.violin.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties marker - plotly.graph_objects.violin.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties meanline - plotly.graph_objects.violin.Meanline instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -6704,8 +6711,8 @@ def __init__( width*count* means the violins are scaled by the number of sample points makingup each violin. selected - plotly.graph_objects.violin.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -6736,8 +6743,8 @@ def __init__( settings, use mode "manual" and fill in the `span` attribute. stream - plotly.graph_objects.violin.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -6770,8 +6777,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.violin.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -6830,7 +6837,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Violin constructor must be a dict or -an instance of plotly.graph_objs.Violin""" +an instance of :class:`plotly.graph_objs.Violin`""" ) # Handle skip_invalid @@ -7133,7 +7140,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.treemap.Domain + - An instance of :class:`plotly.graph_objs.treemap.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -7216,7 +7223,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.treemap.Hoverlabel + - An instance of :class:`plotly.graph_objs.treemap.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -7427,7 +7434,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.treemap.Insidetextfont + - An instance of :class:`plotly.graph_objs.treemap.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -7542,7 +7549,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.treemap.Marker + - An instance of :class:`plotly.graph_objs.treemap.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -7595,8 +7602,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.treemap.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Col + orBar` instance or dict with compatible + properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is @@ -7632,11 +7640,11 @@ def marker(self): colors while the leaves are faded towards the background color. line - plotly.graph_objects.treemap.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Lin + e` instance or dict with compatible properties pad - plotly.graph_objects.treemap.marker.Pad - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Pad + ` instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical @@ -7783,7 +7791,7 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of plotly.graph_objs.treemap.Outsidetextfont + - An instance of :class:`plotly.graph_objs.treemap.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor @@ -7881,7 +7889,7 @@ def pathbar(self): """ The 'pathbar' property is an instance of Pathbar that may be specified as: - - An instance of plotly.graph_objs.treemap.Pathbar + - An instance of :class:`plotly.graph_objs.treemap.Pathbar` - A dict of string/value properties that will be passed to the Pathbar constructor @@ -7921,7 +7929,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.treemap.Stream + - An instance of :class:`plotly.graph_objs.treemap.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -7980,7 +7988,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.treemap.Textfont + - An instance of :class:`plotly.graph_objs.treemap.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -8156,7 +8164,7 @@ def tiling(self): """ The 'tiling' property is an instance of Tiling that may be specified as: - - An instance of plotly.graph_objs.treemap.Tiling + - An instance of :class:`plotly.graph_objs.treemap.Tiling` - A dict of string/value properties that will be passed to the Tiling constructor @@ -8353,8 +8361,8 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.treemap.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -8363,8 +8371,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.treemap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -8421,8 +8429,8 @@ def _prop_descriptions(self): filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.treemap.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -8464,11 +8472,11 @@ def _prop_descriptions(self): parentssrc Sets the source reference on plot.ly for parents . pathbar - plotly.graph_objects.treemap.Pathbar instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties stream - plotly.graph_objects.treemap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -8505,8 +8513,8 @@ def _prop_descriptions(self): Sets the source reference on plot.ly for texttemplate . tiling - plotly.graph_objects.treemap.Tiling instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -8601,7 +8609,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Treemap + an instance of :class:`plotly.graph_objs.Treemap` branchvalues Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value @@ -8621,8 +8629,8 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.treemap.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -8631,8 +8639,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.treemap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -8689,8 +8697,8 @@ def __init__( filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.treemap.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -8732,11 +8740,11 @@ def __init__( parentssrc Sets the source reference on plot.ly for parents . pathbar - plotly.graph_objects.treemap.Pathbar instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties stream - plotly.graph_objects.treemap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -8773,8 +8781,8 @@ def __init__( Sets the source reference on plot.ly for texttemplate . tiling - plotly.graph_objects.treemap.Tiling instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -8828,7 +8836,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Treemap constructor must be a dict or -an instance of plotly.graph_objs.Treemap""" +an instance of :class:`plotly.graph_objs.Treemap`""" ) # Handle skip_invalid @@ -9005,7 +9013,7 @@ def cells(self): """ The 'cells' property is an instance of Cells that may be specified as: - - An instance of plotly.graph_objs.table.Cells + - An instance of :class:`plotly.graph_objs.table.Cells` - A dict of string/value properties that will be passed to the Cells constructor @@ -9021,11 +9029,11 @@ def cells(self): Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.cells.Fill instance - or dict with compatible properties + :class:`plotly.graph_objects.table.cells.Fill` + instance or dict with compatible properties font - plotly.graph_objects.table.cells.Font instance - or dict with compatible properties + :class:`plotly.graph_objects.table.cells.Font` + instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to @@ -9038,8 +9046,8 @@ def cells(self): height The height of cells. line - plotly.graph_objects.table.cells.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.table.cells.Line` + instance or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -9206,7 +9214,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.table.Domain + - An instance of :class:`plotly.graph_objs.table.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -9242,7 +9250,7 @@ def header(self): """ The 'header' property is an instance of Header that may be specified as: - - An instance of plotly.graph_objs.table.Header + - An instance of :class:`plotly.graph_objs.table.Header` - A dict of string/value properties that will be passed to the Header constructor @@ -9258,11 +9266,11 @@ def header(self): Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.header.Fill instance - or dict with compatible properties + :class:`plotly.graph_objects.table.header.Fill` + instance or dict with compatible properties font - plotly.graph_objects.table.header.Font instance - or dict with compatible properties + :class:`plotly.graph_objects.table.header.Font` + instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to @@ -9275,8 +9283,8 @@ def header(self): height The height of cells. line - plotly.graph_objects.table.header.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.table.header.Line` + instance or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -9361,7 +9369,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.table.Hoverlabel + - An instance of :class:`plotly.graph_objs.table.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -9532,7 +9540,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.table.Stream + - An instance of :class:`plotly.graph_objs.table.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -9654,8 +9662,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ cells - plotly.graph_objects.table.Cells instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column @@ -9677,11 +9685,11 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.table.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties header - plotly.graph_objects.table.Header instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -9690,8 +9698,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.table.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -9717,8 +9725,8 @@ def _prop_descriptions(self): Sets the trace name. The trace name appear as the legend item and on hover. stream - plotly.graph_objects.table.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -9787,10 +9795,10 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Table + an instance of :class:`plotly.graph_objs.Table` cells - plotly.graph_objects.table.Cells instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column @@ -9812,11 +9820,11 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.table.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties header - plotly.graph_objects.table.Header instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -9825,8 +9833,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.table.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -9852,8 +9860,8 @@ def __init__( Sets the trace name. The trace name appear as the legend item and on hover. stream - plotly.graph_objects.table.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -9901,7 +9909,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Table constructor must be a dict or -an instance of plotly.graph_objs.Table""" +an instance of :class:`plotly.graph_objs.Table`""" ) # Handle skip_invalid @@ -10155,7 +10163,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.surface.ColorBar + - An instance of :class:`plotly.graph_objs.surface.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -10287,9 +10295,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.surface.colorba - r.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.surface + .colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.surface.colorbar.tickformatstopdefaults), @@ -10335,8 +10343,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.surface.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.colorbar.T + itle` instance or dict with compatible + properties titlefont Deprecated: Please use surface.colorbar.title.font instead. Sets this @@ -10462,21 +10471,21 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of plotly.graph_objs.surface.Contours + - An instance of :class:`plotly.graph_objs.surface.Contours` - A dict of string/value properties that will be passed to the Contours constructor Supported dict properties: x - plotly.graph_objects.surface.contours.X - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.X + ` instance or dict with compatible properties y - plotly.graph_objects.surface.contours.Y - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Y + ` instance or dict with compatible properties z - plotly.graph_objects.surface.contours.Z - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Z + ` instance or dict with compatible properties Returns ------- @@ -10606,7 +10615,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.surface.Hoverlabel + - An instance of :class:`plotly.graph_objs.surface.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -10833,7 +10842,7 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of plotly.graph_objs.surface.Lighting + - An instance of :class:`plotly.graph_objs.surface.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor @@ -10875,7 +10884,7 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of plotly.graph_objs.surface.Lightposition + - An instance of :class:`plotly.graph_objs.surface.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor @@ -11092,7 +11101,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.surface.Stream + - An instance of :class:`plotly.graph_objs.surface.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -11523,8 +11532,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.surface.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -11541,8 +11550,8 @@ def _prop_descriptions(self): Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours - plotly.graph_objects.surface.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -11563,8 +11572,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.surface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -11606,11 +11615,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.surface.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.surface.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11654,8 +11663,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.surface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. @@ -11788,7 +11797,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Surface + an instance of :class:`plotly.graph_objs.Surface` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -11822,8 +11831,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.surface.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -11840,8 +11849,8 @@ def __init__( Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours - plotly.graph_objects.surface.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -11862,8 +11871,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.surface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -11905,11 +11914,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.surface.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.surface.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11953,8 +11962,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.surface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. @@ -12033,7 +12042,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Surface constructor must be a dict or -an instance of plotly.graph_objs.Surface""" +an instance of :class:`plotly.graph_objs.Surface`""" ) # Handle skip_invalid @@ -12327,7 +12336,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.sunburst.Domain + - An instance of :class:`plotly.graph_objs.sunburst.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -12410,7 +12419,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.sunburst.Hoverlabel + - An instance of :class:`plotly.graph_objs.sunburst.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -12621,7 +12630,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.sunburst.Insidetextfont + - An instance of :class:`plotly.graph_objs.sunburst.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -12742,7 +12751,7 @@ def leaf(self): """ The 'leaf' property is an instance of Leaf that may be specified as: - - An instance of plotly.graph_objs.sunburst.Leaf + - An instance of :class:`plotly.graph_objs.sunburst.Leaf` - A dict of string/value properties that will be passed to the Leaf constructor @@ -12792,7 +12801,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.sunburst.Marker + - An instance of :class:`plotly.graph_objs.sunburst.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -12845,8 +12854,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.sunburst.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.Co + lorBar` instance or dict with compatible + properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is @@ -12871,8 +12881,8 @@ def marker(self): Sets the source reference on plot.ly for colors . line - plotly.graph_objects.sunburst.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.Li + ne` instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical @@ -13019,7 +13029,7 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of plotly.graph_objs.sunburst.Outsidetextfont + - An instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor @@ -13117,7 +13127,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.sunburst.Stream + - An instance of :class:`plotly.graph_objs.sunburst.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -13176,7 +13186,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.sunburst.Textfont + - An instance of :class:`plotly.graph_objs.sunburst.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -13477,8 +13487,8 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sunburst.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -13487,8 +13497,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.sunburst.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -13549,8 +13559,8 @@ def _prop_descriptions(self): labelssrc Sets the source reference on plot.ly for labels . leaf - plotly.graph_objects.sunburst.Leaf instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root @@ -13558,8 +13568,8 @@ def _prop_descriptions(self): filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.sunburst.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -13601,8 +13611,8 @@ def _prop_descriptions(self): parentssrc Sets the source reference on plot.ly for parents . stream - plotly.graph_objects.sunburst.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -13728,7 +13738,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Sunburst + an instance of :class:`plotly.graph_objs.Sunburst` branchvalues Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value @@ -13748,8 +13758,8 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sunburst.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -13758,8 +13768,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.sunburst.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -13820,8 +13830,8 @@ def __init__( labelssrc Sets the source reference on plot.ly for labels . leaf - plotly.graph_objects.sunburst.Leaf instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root @@ -13829,8 +13839,8 @@ def __init__( filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.sunburst.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -13872,8 +13882,8 @@ def __init__( parentssrc Sets the source reference on plot.ly for parents . stream - plotly.graph_objects.sunburst.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -13960,7 +13970,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Sunburst constructor must be a dict or -an instance of plotly.graph_objs.Sunburst""" +an instance of :class:`plotly.graph_objs.Sunburst`""" ) # Handle skip_invalid @@ -14280,7 +14290,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.streamtube.ColorBar + - An instance of :class:`plotly.graph_objs.streamtube.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -14412,9 +14422,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.streamtube.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.streamt + ube.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.streamtube.colorbar.tickformatstopdefaults), @@ -14460,8 +14470,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.streamtube.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.streamtube.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use streamtube.colorbar.title.font instead. Sets @@ -14655,7 +14666,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.streamtube.Hoverlabel + - An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -14862,7 +14873,7 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of plotly.graph_objs.streamtube.Lighting + - An instance of :class:`plotly.graph_objs.streamtube.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor @@ -14910,7 +14921,7 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of plotly.graph_objs.streamtube.Lightposition + - An instance of :class:`plotly.graph_objs.streamtube.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor @@ -15170,7 +15181,7 @@ def starts(self): """ The 'starts' property is an instance of Starts that may be specified as: - - An instance of plotly.graph_objs.streamtube.Starts + - An instance of :class:`plotly.graph_objs.streamtube.Starts` - A dict of string/value properties that will be passed to the Starts constructor @@ -15209,7 +15220,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.streamtube.Stream + - An instance of :class:`plotly.graph_objs.streamtube.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -15627,8 +15638,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.streamtube.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -15656,8 +15667,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.streamtube.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -15699,11 +15710,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.streamtube.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.streamtube.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties maxdisplayed The maximum number of displayed segments in a streamtube. @@ -15754,11 +15765,11 @@ def _prop_descriptions(self): 1, which avoids two max divergence tubes from touching at adjacent starting positions. starts - plotly.graph_objects.streamtube.Starts instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties stream - plotly.graph_objects.streamtube.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text @@ -15888,7 +15899,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Streamtube + an instance of :class:`plotly.graph_objs.Streamtube` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -15922,8 +15933,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.streamtube.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -15951,8 +15962,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.streamtube.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -15994,11 +16005,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.streamtube.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.streamtube.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties maxdisplayed The maximum number of displayed segments in a streamtube. @@ -16049,11 +16060,11 @@ def __init__( 1, which avoids two max divergence tubes from touching at adjacent starting positions. starts - plotly.graph_objects.streamtube.Starts instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties stream - plotly.graph_objects.streamtube.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text @@ -16130,7 +16141,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Streamtube constructor must be a dict or -an instance of plotly.graph_objs.Streamtube""" +an instance of :class:`plotly.graph_objs.Streamtube`""" ) # Handle skip_invalid @@ -16371,7 +16382,7 @@ def diagonal(self): """ The 'diagonal' property is an instance of Diagonal that may be specified as: - - An instance of plotly.graph_objs.splom.Diagonal + - An instance of :class:`plotly.graph_objs.splom.Diagonal` - A dict of string/value properties that will be passed to the Diagonal constructor @@ -16405,8 +16416,8 @@ def dimensions(self): Supported dict properties: axis - plotly.graph_objects.splom.dimension.Axis - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.dimension.Ax + is` instance or dict with compatible properties label Sets the label corresponding to this splom dimension. @@ -16463,7 +16474,7 @@ def dimensiondefaults(self): The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - - An instance of plotly.graph_objs.splom.Dimension + - An instance of :class:`plotly.graph_objs.splom.Dimension` - A dict of string/value properties that will be passed to the Dimension constructor @@ -16532,7 +16543,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.splom.Hoverlabel + - An instance of :class:`plotly.graph_objs.splom.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -16759,7 +16770,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.splom.Marker + - An instance of :class:`plotly.graph_objs.splom.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -16819,8 +16830,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.splom.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.Color + Bar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -16841,8 +16853,8 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.splom.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -16995,15 +17007,16 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.splom.Selected + - An instance of :class:`plotly.graph_objs.splom.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.splom.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.selected.Mar + ker` instance or dict with compatible + properties Returns ------- @@ -17109,7 +17122,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.splom.Stream + - An instance of :class:`plotly.graph_objs.splom.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -17242,15 +17255,16 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.splom.Unselected + - An instance of :class:`plotly.graph_objs.splom.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.splom.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.unselected.M + arker` instance or dict with compatible + properties Returns ------- @@ -17368,11 +17382,12 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . diagonal - plotly.graph_objects.splom.Diagonal instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties dimensions - A tuple of plotly.graph_objects.splom.Dimension - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties dimensiondefaults When used in a template (as layout.template.data.splom.dimensiondefaults), sets the @@ -17386,8 +17401,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.splom.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -17429,8 +17444,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.splom.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -17452,8 +17467,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. selected - plotly.graph_objects.splom.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -17471,8 +17486,8 @@ def _prop_descriptions(self): Determines whether or not subplots on the upper half from the diagonal are displayed. stream - plotly.graph_objects.splom.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string @@ -17504,8 +17519,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.splom.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -17583,7 +17598,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Splom + an instance of :class:`plotly.graph_objs.Splom` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -17592,11 +17607,12 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . diagonal - plotly.graph_objects.splom.Diagonal instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties dimensions - A tuple of plotly.graph_objects.splom.Dimension - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties dimensiondefaults When used in a template (as layout.template.data.splom.dimensiondefaults), sets the @@ -17610,8 +17626,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.splom.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -17653,8 +17669,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.splom.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -17676,8 +17692,8 @@ def __init__( opacity Sets the opacity of the trace. selected - plotly.graph_objects.splom.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -17695,8 +17711,8 @@ def __init__( Determines whether or not subplots on the upper half from the diagonal are displayed. stream - plotly.graph_objects.splom.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string @@ -17728,8 +17744,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.splom.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -17771,7 +17787,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Splom constructor must be a dict or -an instance of plotly.graph_objs.Splom""" +an instance of :class:`plotly.graph_objs.Splom`""" ) # Handle skip_invalid @@ -18278,7 +18294,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Hoverlabel + - An instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -18534,7 +18550,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Line + - An instance of :class:`plotly.graph_objs.scatterternary.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -18577,7 +18593,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Marker + - An instance of :class:`plotly.graph_objs.scatterternary.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -18637,8 +18653,8 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterternary.marker.Colo - rBar instance or dict with compatible + :class:`plotly.graph_objects.scatterternary.mar + ker.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in @@ -18660,12 +18676,13 @@ def marker(self): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterternary.marker.Grad - ient instance or dict with compatible + :class:`plotly.graph_objects.scatterternary.mar + ker.Gradient` instance or dict with compatible properties line - plotly.graph_objects.scatterternary.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.mar + ker.Line` instance or dict with compatible + properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -18849,20 +18866,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Selected + - An instance of :class:`plotly.graph_objs.scatterternary.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scatterternary.selected.Ma - rker instance or dict with compatible + :class:`plotly.graph_objects.scatterternary.sel + ected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterternary.selected.Te - xtfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.sel + ected.Textfont` instance or dict with + compatible properties Returns ------- @@ -18926,7 +18943,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Stream + - An instance of :class:`plotly.graph_objs.scatterternary.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -19037,7 +19054,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Textfont + - An instance of :class:`plotly.graph_objs.scatterternary.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -19265,20 +19282,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Unselected + - An instance of :class:`plotly.graph_objs.scatterternary.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scatterternary.unselected. - Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.uns + elected.Marker` instance or dict with + compatible properties textfont - plotly.graph_objects.scatterternary.unselected. - Textfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.uns + elected.Textfont` instance or dict with + compatible properties Returns ------- @@ -19393,8 +19410,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterternary.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -19447,11 +19464,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterternary.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterternary.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -19480,8 +19497,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scatterternary.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -19493,8 +19510,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterternary.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default @@ -19568,8 +19585,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterternary.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -19640,7 +19657,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatterternary + an instance of + :class:`plotly.graph_objs.Scatterternary` a Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be @@ -19704,8 +19722,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterternary.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -19758,11 +19776,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterternary.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterternary.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -19791,8 +19809,8 @@ def __init__( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scatterternary.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -19804,8 +19822,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterternary.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default @@ -19879,8 +19897,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterternary.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -19906,7 +19924,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scatterternary constructor must be a dict or -an instance of plotly.graph_objs.Scatterternary""" +an instance of :class:`plotly.graph_objs.Scatterternary`""" ) # Handle skip_invalid @@ -20357,7 +20375,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Hoverlabel + - An instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -20588,7 +20606,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Line + - An instance of :class:`plotly.graph_objs.scatterpolargl.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -20621,7 +20639,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Marker + - An instance of :class:`plotly.graph_objs.scatterpolargl.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -20681,8 +20699,8 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolargl.marker.Colo - rBar instance or dict with compatible + :class:`plotly.graph_objects.scatterpolargl.mar + ker.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in @@ -20704,8 +20722,9 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatterpolargl.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.mar + ker.Line` instance or dict with compatible + properties opacity Sets the marker opacity. opacitysrc @@ -20947,20 +20966,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Selected + - An instance of :class:`plotly.graph_objs.scatterpolargl.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scatterpolargl.selected.Ma - rker instance or dict with compatible + :class:`plotly.graph_objects.scatterpolargl.sel + ected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolargl.selected.Te - xtfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.sel + ected.Textfont` instance or dict with + compatible properties Returns ------- @@ -21024,7 +21043,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Stream + - An instance of :class:`plotly.graph_objs.scatterpolargl.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -21111,7 +21130,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Textfont + - An instance of :class:`plotly.graph_objs.scatterpolargl.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -21422,20 +21441,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Unselected + - An instance of :class:`plotly.graph_objs.scatterpolargl.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scatterpolargl.unselected. - Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.uns + elected.Marker` instance or dict with + compatible properties textfont - plotly.graph_objects.scatterpolargl.unselected. - Textfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.uns + elected.Textfont` instance or dict with + compatible properties Returns ------- @@ -21538,8 +21557,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolargl.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -21586,11 +21605,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolargl.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolargl.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -21627,8 +21646,8 @@ def _prop_descriptions(self): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolargl.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -21640,8 +21659,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolargl.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -21719,8 +21738,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolargl.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -21794,7 +21813,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatterpolargl + an instance of + :class:`plotly.graph_objs.Scatterpolargl` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. @@ -21846,8 +21866,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolargl.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -21894,11 +21914,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolargl.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolargl.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -21935,8 +21955,8 @@ def __init__( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolargl.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -21948,8 +21968,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolargl.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -22027,8 +22047,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolargl.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -22054,7 +22074,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scatterpolargl constructor must be a dict or -an instance of plotly.graph_objs.Scatterpolargl""" +an instance of :class:`plotly.graph_objs.Scatterpolargl`""" ) # Handle skip_invalid @@ -22517,7 +22537,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Hoverlabel + - An instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -22773,7 +22793,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Line + - An instance of :class:`plotly.graph_objs.scatterpolar.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -22816,7 +22836,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Marker + - An instance of :class:`plotly.graph_objs.scatterpolar.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -22876,8 +22896,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolar.marker.ColorB - ar instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marke + r.ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -22898,11 +22919,13 @@ def marker(self): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterpolar.marker.Gradie - nt instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marke + r.Gradient` instance or dict with compatible + properties line - plotly.graph_objects.scatterpolar.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marke + r.Line` instance or dict with compatible + properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -23147,18 +23170,19 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Selected + - An instance of :class:`plotly.graph_objs.scatterpolar.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scatterpolar.selected.Mark - er instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.selec + ted.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scatterpolar.selected.Text - font instance or dict with compatible + :class:`plotly.graph_objects.scatterpolar.selec + ted.Textfont` instance or dict with compatible properties Returns @@ -23223,7 +23247,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Stream + - An instance of :class:`plotly.graph_objs.scatterpolar.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -23310,7 +23334,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Textfont + - An instance of :class:`plotly.graph_objs.scatterpolar.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -23621,20 +23645,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Unselected + - An instance of :class:`plotly.graph_objs.scatterpolar.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scatterpolar.unselected.Ma - rker instance or dict with compatible + :class:`plotly.graph_objects.scatterpolar.unsel + ected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolar.unselected.Te - xtfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolar.unsel + ected.Textfont` instance or dict with + compatible properties Returns ------- @@ -23731,8 +23755,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolar.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -23785,11 +23809,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolar.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolar.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -23826,8 +23850,8 @@ def _prop_descriptions(self): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolar.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -23839,8 +23863,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolar.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -23918,8 +23942,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolar.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -23996,7 +24020,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatterpolar + an instance of :class:`plotly.graph_objs.Scatterpolar` cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and @@ -24042,8 +24066,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolar.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -24096,11 +24120,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolar.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolar.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -24137,8 +24161,8 @@ def __init__( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolar.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -24150,8 +24174,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolar.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -24229,8 +24253,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolar.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -24256,7 +24280,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scatterpolar constructor must be a dict or -an instance of plotly.graph_objs.Scatterpolar""" +an instance of :class:`plotly.graph_objs.Scatterpolar`""" ) # Handle skip_invalid @@ -24675,7 +24699,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Hoverlabel + - An instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -24946,7 +24970,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Line + - An instance of :class:`plotly.graph_objs.scattermapbox.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -25014,7 +25038,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Marker + - An instance of :class:`plotly.graph_objs.scattermapbox.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -25074,8 +25098,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattermapbox.marker.Color - Bar instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.mark + er.ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -25271,15 +25296,16 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Selected + - An instance of :class:`plotly.graph_objs.scattermapbox.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scattermapbox.selected.Mar - ker instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.sele + cted.Marker` instance or dict with compatible + properties Returns ------- @@ -25343,7 +25369,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Stream + - An instance of :class:`plotly.graph_objs.scattermapbox.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -25432,7 +25458,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Textfont + - An instance of :class:`plotly.graph_objs.scattermapbox.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -25629,15 +25655,15 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Unselected + - An instance of :class:`plotly.graph_objs.scattermapbox.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scattermapbox.unselected.M - arker instance or dict with compatible + :class:`plotly.graph_objects.scattermapbox.unse + lected.Marker` instance or dict with compatible properties Returns @@ -25723,8 +25749,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattermapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -25775,15 +25801,15 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattermapbox.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattermapbox.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -25810,8 +25836,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattermapbox.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -25823,8 +25849,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattermapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -25890,8 +25916,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattermapbox.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -25957,7 +25983,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattermapbox + an instance of :class:`plotly.graph_objs.Scattermapbox` below Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By @@ -25991,8 +26017,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattermapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -26043,15 +26069,15 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattermapbox.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattermapbox.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -26078,8 +26104,8 @@ def __init__( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattermapbox.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -26091,8 +26117,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattermapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -26158,8 +26184,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattermapbox.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -26185,7 +26211,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scattermapbox constructor must be a dict or -an instance of plotly.graph_objs.Scattermapbox""" +an instance of :class:`plotly.graph_objs.Scattermapbox`""" ) # Handle skip_invalid @@ -26468,7 +26494,7 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of plotly.graph_objs.scattergl.ErrorX + - An instance of :class:`plotly.graph_objs.scattergl.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor @@ -26549,7 +26575,7 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of plotly.graph_objs.scattergl.ErrorY + - An instance of :class:`plotly.graph_objs.scattergl.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor @@ -26775,7 +26801,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scattergl.Hoverlabel + - An instance of :class:`plotly.graph_objs.scattergl.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -27006,7 +27032,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattergl.Line + - An instance of :class:`plotly.graph_objs.scattergl.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -27039,7 +27065,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattergl.Marker + - An instance of :class:`plotly.graph_objs.scattergl.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -27099,8 +27125,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergl.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -27121,8 +27148,9 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.scattergl.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.L + ine` instance or dict with compatible + properties opacity Sets the marker opacity. opacitysrc @@ -27298,18 +27326,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scattergl.Selected + - An instance of :class:`plotly.graph_objs.scattergl.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scattergl.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.selected + .Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergl.selected.Textfon - t instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.selected + .Textfont` instance or dict with compatible + properties Returns ------- @@ -27373,7 +27403,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scattergl.Stream + - An instance of :class:`plotly.graph_objs.scattergl.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -27435,7 +27465,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattergl.Textfont + - An instance of :class:`plotly.graph_objs.scattergl.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -27663,18 +27693,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scattergl.Unselected + - An instance of :class:`plotly.graph_objs.scattergl.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scattergl.unselected.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselect + ed.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergl.unselected.Textf - ont instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselect + ed.Textfont` instance or dict with compatible + properties Returns ------- @@ -27961,11 +27993,11 @@ def _prop_descriptions(self): dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scattergl.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scattergl.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -28001,8 +28033,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -28049,11 +28081,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergl.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scattergl.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -28077,8 +28109,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergl.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -28090,8 +28122,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -28152,8 +28184,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergl.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -28259,7 +28291,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattergl + an instance of :class:`plotly.graph_objs.Scattergl` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. @@ -28275,11 +28307,11 @@ def __init__( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scattergl.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scattergl.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -28315,8 +28347,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -28363,11 +28395,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergl.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scattergl.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -28391,8 +28423,8 @@ def __init__( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergl.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -28404,8 +28436,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -28466,8 +28498,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergl.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -28523,7 +28555,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scattergl constructor must be a dict or -an instance of plotly.graph_objs.Scattergl""" +an instance of :class:`plotly.graph_objs.Scattergl`""" ) # Handle skip_invalid @@ -28994,7 +29026,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Hoverlabel + - An instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -29266,7 +29298,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Line + - An instance of :class:`plotly.graph_objs.scattergeo.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -29406,7 +29438,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Marker + - An instance of :class:`plotly.graph_objs.scattergeo.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -29466,8 +29498,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergeo.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker. + ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -29488,11 +29521,13 @@ def marker(self): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattergeo.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker. + Gradient` instance or dict with compatible + properties line - plotly.graph_objects.scattergeo.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker. + Line` instance or dict with compatible + properties opacity Sets the marker opacity. opacitysrc @@ -29673,18 +29708,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Selected + - An instance of :class:`plotly.graph_objs.scattergeo.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scattergeo.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selecte + d.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergeo.selected.Textfo - nt instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selecte + d.Textfont` instance or dict with compatible + properties Returns ------- @@ -29748,7 +29785,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Stream + - An instance of :class:`plotly.graph_objs.scattergeo.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -29811,7 +29848,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Textfont + - An instance of :class:`plotly.graph_objs.scattergeo.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -30039,18 +30076,19 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Unselected + - An instance of :class:`plotly.graph_objs.scattergeo.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scattergeo.unselected.Mark - er instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.unselec + ted.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergeo.unselected.Text - font instance or dict with compatible + :class:`plotly.graph_objects.scattergeo.unselec + ted.Textfont` instance or dict with compatible properties Returns @@ -30149,8 +30187,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergeo.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -30201,8 +30239,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergeo.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", @@ -30221,8 +30259,8 @@ def _prop_descriptions(self): lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattergeo.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -30251,8 +30289,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergeo.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -30264,8 +30302,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergeo.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same @@ -30328,8 +30366,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergeo.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -30401,7 +30439,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattergeo + an instance of :class:`plotly.graph_objs.Scattergeo` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. @@ -30448,8 +30486,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergeo.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -30500,8 +30538,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergeo.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", @@ -30520,8 +30558,8 @@ def __init__( lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattergeo.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -30550,8 +30588,8 @@ def __init__( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergeo.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -30563,8 +30601,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergeo.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same @@ -30627,8 +30665,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergeo.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -30654,7 +30692,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scattergeo constructor must be a dict or -an instance of plotly.graph_objs.Scattergeo""" +an instance of :class:`plotly.graph_objs.Scattergeo`""" ) # Handle skip_invalid @@ -31149,7 +31187,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Hoverlabel + - An instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -31405,7 +31443,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Line + - An instance of :class:`plotly.graph_objs.scattercarpet.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -31448,7 +31486,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Marker + - An instance of :class:`plotly.graph_objs.scattercarpet.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -31508,8 +31546,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattercarpet.marker.Color - Bar instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.mark + er.ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -31530,11 +31569,13 @@ def marker(self): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattercarpet.marker.Gradi - ent instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.mark + er.Gradient` instance or dict with compatible + properties line - plotly.graph_objects.scattercarpet.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.mark + er.Line` instance or dict with compatible + properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -31718,18 +31759,19 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Selected + - An instance of :class:`plotly.graph_objs.scattercarpet.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scattercarpet.selected.Mar - ker instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.sele + cted.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattercarpet.selected.Tex - tfont instance or dict with compatible + :class:`plotly.graph_objects.scattercarpet.sele + cted.Textfont` instance or dict with compatible properties Returns @@ -31794,7 +31836,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Stream + - An instance of :class:`plotly.graph_objs.scattercarpet.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -31856,7 +31898,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Textfont + - An instance of :class:`plotly.graph_objs.scattercarpet.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -32084,20 +32126,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Unselected + - An instance of :class:`plotly.graph_objs.scattercarpet.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scattercarpet.unselected.M - arker instance or dict with compatible + :class:`plotly.graph_objects.scattercarpet.unse + lected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scattercarpet.unselected.T - extfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scattercarpet.unse + lected.Textfont` instance or dict with + compatible properties Returns ------- @@ -32244,8 +32286,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattercarpet.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -32297,11 +32339,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattercarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scattercarpet.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -32330,8 +32372,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattercarpet.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -32343,8 +32385,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattercarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the @@ -32406,8 +32448,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattercarpet.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -32485,7 +32527,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattercarpet + an instance of :class:`plotly.graph_objs.Scattercarpet` a Sets the a-axis coordinates. asrc @@ -32531,8 +32573,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattercarpet.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -32584,11 +32626,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattercarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scattercarpet.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -32617,8 +32659,8 @@ def __init__( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattercarpet.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -32630,8 +32672,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattercarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the @@ -32693,8 +32735,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattercarpet.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -32730,7 +32772,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scattercarpet constructor must be a dict or -an instance of plotly.graph_objs.Scattercarpet""" +an instance of :class:`plotly.graph_objs.Scattercarpet`""" ) # Handle skip_invalid @@ -32982,7 +33024,7 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of plotly.graph_objs.scatter3d.ErrorX + - An instance of :class:`plotly.graph_objs.scatter3d.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor @@ -33063,7 +33105,7 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of plotly.graph_objs.scatter3d.ErrorY + - An instance of :class:`plotly.graph_objs.scatter3d.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor @@ -33144,7 +33186,7 @@ def error_z(self): """ The 'error_z' property is an instance of ErrorZ that may be specified as: - - An instance of plotly.graph_objs.scatter3d.ErrorZ + - An instance of :class:`plotly.graph_objs.scatter3d.ErrorZ` - A dict of string/value properties that will be passed to the ErrorZ constructor @@ -33269,7 +33311,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Hoverlabel + - An instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -33500,7 +33542,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Line + - An instance of :class:`plotly.graph_objs.scatter3d.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -33560,8 +33602,9 @@ def line(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.line.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.Col + orBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The @@ -33613,7 +33656,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Marker + - An instance of :class:`plotly.graph_objs.scatter3d.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -33673,8 +33716,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -33695,8 +33739,9 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatter3d.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.L + ine` instance or dict with compatible + properties opacity Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar @@ -33874,21 +33919,24 @@ def projection(self): """ The 'projection' property is an instance of Projection that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Projection + - An instance of :class:`plotly.graph_objs.scatter3d.Projection` - A dict of string/value properties that will be passed to the Projection constructor Supported dict properties: x - plotly.graph_objects.scatter3d.projection.X - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projecti + on.X` instance or dict with compatible + properties y - plotly.graph_objects.scatter3d.projection.Y - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projecti + on.Y` instance or dict with compatible + properties z - plotly.graph_objects.scatter3d.projection.Z - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projecti + on.Z` instance or dict with compatible + properties Returns ------- @@ -33953,7 +34001,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Stream + - An instance of :class:`plotly.graph_objs.scatter3d.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -34095,7 +34143,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Textfont + - An instance of :class:`plotly.graph_objs.scatter3d.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -34556,14 +34604,14 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.scatter3d.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter3d.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties error_z - plotly.graph_objects.scatter3d.ErrorZ instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -34572,8 +34620,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter3d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -34620,11 +34668,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter3d.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scatter3d.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -34653,8 +34701,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. projection - plotly.graph_objects.scatter3d.Projection instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), @@ -34665,8 +34713,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatter3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a @@ -34682,8 +34730,8 @@ def _prop_descriptions(self): flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont - plotly.graph_objects.scatter3d.Textfont instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Textfont` + instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. @@ -34825,7 +34873,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatter3d + an instance of :class:`plotly.graph_objs.Scatter3d` connectgaps Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. @@ -34837,14 +34885,14 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.scatter3d.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter3d.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties error_z - plotly.graph_objects.scatter3d.ErrorZ instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -34853,8 +34901,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter3d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -34901,11 +34949,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter3d.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scatter3d.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -34934,8 +34982,8 @@ def __init__( opacity Sets the opacity of the trace. projection - plotly.graph_objects.scatter3d.Projection instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), @@ -34946,8 +34994,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatter3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a @@ -34963,8 +35011,8 @@ def __init__( flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont - plotly.graph_objects.scatter3d.Textfont instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Textfont` + instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. @@ -35057,7 +35105,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scatter3d constructor must be a dict or -an instance of plotly.graph_objs.Scatter3d""" +an instance of :class:`plotly.graph_objs.Scatter3d`""" ) # Handle skip_invalid @@ -35379,7 +35427,7 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of plotly.graph_objs.scatter.ErrorX + - An instance of :class:`plotly.graph_objs.scatter.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor @@ -35460,7 +35508,7 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of plotly.graph_objs.scatter.ErrorY + - An instance of :class:`plotly.graph_objs.scatter.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor @@ -35715,7 +35763,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.scatter.Hoverlabel + - An instance of :class:`plotly.graph_objs.scatter.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -35971,7 +36019,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatter.Line + - An instance of :class:`plotly.graph_objs.scatter.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -36020,7 +36068,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatter.Marker + - An instance of :class:`plotly.graph_objs.scatter.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -36080,8 +36128,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Col + orBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -36102,11 +36151,12 @@ def marker(self): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatter.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Gra + dient` instance or dict with compatible + properties line - plotly.graph_objects.scatter.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Lin + e` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -36358,18 +36408,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.scatter.Selected + - An instance of :class:`plotly.graph_objs.scatter.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.scatter.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.M + arker` instance or dict with compatible + properties textfont - plotly.graph_objects.scatter.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.T + extfont` instance or dict with compatible + properties Returns ------- @@ -36493,7 +36545,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.scatter.Stream + - An instance of :class:`plotly.graph_objs.scatter.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -36577,7 +36629,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatter.Textfont + - An instance of :class:`plotly.graph_objs.scatter.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -36825,18 +36877,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.scatter.Unselected + - An instance of :class:`plotly.graph_objs.scatter.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.scatter.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.unselected + .Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scatter.unselected.Textfon - t instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.unselected + .Textfont` instance or dict with compatible + properties Returns ------- @@ -37129,11 +37183,11 @@ def _prop_descriptions(self): dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scatter.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -37180,8 +37234,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -37234,11 +37288,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties marker - plotly.graph_objects.scatter.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -37280,8 +37334,8 @@ def _prop_descriptions(self): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatter.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -37317,8 +37371,8 @@ def _prop_descriptions(self): fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. stream - plotly.graph_objects.scatter.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -37385,8 +37439,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatter.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -37504,7 +37558,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatter + an instance of :class:`plotly.graph_objs.Scatter` cliponaxis Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and @@ -37526,11 +37580,11 @@ def __init__( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scatter.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -37577,8 +37631,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -37631,11 +37685,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties marker - plotly.graph_objects.scatter.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -37677,8 +37731,8 @@ def __init__( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatter.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -37714,8 +37768,8 @@ def __init__( fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. stream - plotly.graph_objects.scatter.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -37782,8 +37836,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatter.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -37839,7 +37893,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Scatter constructor must be a dict or -an instance of plotly.graph_objs.Scatter""" +an instance of :class:`plotly.graph_objs.Scatter`""" ) # Handle skip_invalid @@ -38143,7 +38197,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.sankey.Domain + - An instance of :class:`plotly.graph_objs.sankey.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -38206,7 +38260,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.sankey.Hoverlabel + - An instance of :class:`plotly.graph_objs.sankey.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -38309,7 +38363,7 @@ def link(self): The 'link' property is an instance of Link that may be specified as: - - An instance of plotly.graph_objs.sankey.Link + - An instance of :class:`plotly.graph_objs.sankey.Link` - A dict of string/value properties that will be passed to the Link constructor @@ -38322,9 +38376,9 @@ def link(self): by default, a translucent grey link will be used. colorscales - A tuple of - plotly.graph_objects.sankey.link.Colorscale - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.sankey. + link.Colorscale` instances or dicts with + compatible properties colorscaledefaults When used in a template (as layout.template.dat a.sankey.link.colorscaledefaults), sets the @@ -38340,8 +38394,9 @@ def link(self): `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.link.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.sankey.link.Hoverl + abel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -38380,8 +38435,8 @@ def link(self): Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.link.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.sankey.link.Line` + instance or dict with compatible properties source An integer number `[0..nodes.length - 1]` that represents the source node. @@ -38490,7 +38545,7 @@ def node(self): The 'node' property is an instance of Node that may be specified as: - - An instance of plotly.graph_objs.sankey.Node + - An instance of :class:`plotly.graph_objs.sankey.Node` - A dict of string/value properties that will be passed to the Node constructor @@ -38518,8 +38573,9 @@ def node(self): `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.node.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.sankey.node.Hoverl + abel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -38558,8 +38614,8 @@ def node(self): Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.node.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.sankey.node.Line` + instance or dict with compatible properties pad Sets the padding (in px) between the `nodes`. thickness @@ -38635,7 +38691,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.sankey.Stream + - An instance of :class:`plotly.graph_objs.sankey.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -38670,7 +38726,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.sankey.Textfont + - An instance of :class:`plotly.graph_objs.sankey.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -38863,8 +38919,8 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sankey.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -38873,8 +38929,8 @@ def _prop_descriptions(self): superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel - plotly.graph_objects.sankey.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -38913,8 +38969,8 @@ def _prop_descriptions(self): any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. stream - plotly.graph_objects.sankey.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties textfont Sets the font for node labels uid @@ -38994,7 +39050,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Sankey + an instance of :class:`plotly.graph_objs.Sankey` arrangement If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to @@ -39011,8 +39067,8 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sankey.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -39021,8 +39077,8 @@ def __init__( superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel - plotly.graph_objects.sankey.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -39061,8 +39117,8 @@ def __init__( any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. stream - plotly.graph_objects.sankey.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties textfont Sets the font for node labels uid @@ -39121,7 +39177,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Sankey constructor must be a dict or -an instance of plotly.graph_objs.Sankey""" +an instance of :class:`plotly.graph_objs.Sankey`""" ) # Handle skip_invalid @@ -39325,7 +39381,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.pointcloud.Hoverlabel + - An instance of :class:`plotly.graph_objs.pointcloud.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -39495,7 +39551,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.pointcloud.Marker + - An instance of :class:`plotly.graph_objs.pointcloud.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -39508,8 +39564,9 @@ def marker(self): `blend` to `true` reduces zoom/pan speed if used with large numbers of points. border - plotly.graph_objects.pointcloud.marker.Border - instance or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.marker. + Border` instance or dict with compatible + properties color Sets the marker fill color. It accepts a specific color.If the color is not fully opaque @@ -39660,7 +39717,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.pointcloud.Stream + - An instance of :class:`plotly.graph_objs.pointcloud.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -40100,8 +40157,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pointcloud.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -40124,8 +40181,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pointcloud.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -40150,8 +40207,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.pointcloud.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -40279,7 +40336,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Pointcloud + an instance of :class:`plotly.graph_objs.Pointcloud` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -40295,8 +40352,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pointcloud.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -40319,8 +40376,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pointcloud.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -40345,8 +40402,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.pointcloud.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -40443,7 +40500,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Pointcloud constructor must be a dict or -an instance of plotly.graph_objs.Pointcloud""" +an instance of :class:`plotly.graph_objs.Pointcloud`""" ) # Handle skip_invalid @@ -40699,7 +40756,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.pie.Domain + - An instance of :class:`plotly.graph_objs.pie.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -40802,7 +40859,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.pie.Hoverlabel + - An instance of :class:`plotly.graph_objs.pie.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -41013,7 +41070,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.pie.Insidetextfont + - An instance of :class:`plotly.graph_objs.pie.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -41183,7 +41240,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.pie.Marker + - An instance of :class:`plotly.graph_objs.pie.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -41197,8 +41254,8 @@ def marker(self): Sets the source reference on plot.ly for colors . line - plotly.graph_objects.pie.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.pie.marker.Line` + instance or dict with compatible properties Returns ------- @@ -41309,7 +41366,7 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of plotly.graph_objs.pie.Outsidetextfont + - An instance of :class:`plotly.graph_objs.pie.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor @@ -41492,7 +41549,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.pie.Stream + - An instance of :class:`plotly.graph_objs.pie.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -41551,7 +41608,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.pie.Textfont + - An instance of :class:`plotly.graph_objs.pie.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -41745,7 +41802,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.pie.Title + - An instance of :class:`plotly.graph_objs.pie.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -41787,7 +41844,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.pie.title.Font + - An instance of :class:`plotly.graph_objs.pie.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -42009,8 +42066,8 @@ def _prop_descriptions(self): dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.pie.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. @@ -42022,8 +42079,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pie.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -42096,8 +42153,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pie.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -42143,8 +42200,8 @@ def _prop_descriptions(self): Determines whether or not the sectors are reordered from largest to smallest. stream - plotly.graph_objects.pie.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -42183,8 +42240,8 @@ def _prop_descriptions(self): Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.pie.Title instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used @@ -42300,7 +42357,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Pie + an instance of :class:`plotly.graph_objs.Pie` automargin Determines whether outside text labels can push the margins. @@ -42317,8 +42374,8 @@ def __init__( dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.pie.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. @@ -42330,8 +42387,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pie.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -42404,8 +42461,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pie.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -42451,8 +42508,8 @@ def __init__( Determines whether or not the sectors are reordered from largest to smallest. stream - plotly.graph_objects.pie.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -42491,8 +42548,8 @@ def __init__( Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.pie.Title instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used @@ -42554,7 +42611,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Pie constructor must be a dict or -an instance of plotly.graph_objs.Pie""" +an instance of :class:`plotly.graph_objs.Pie`""" ) # Handle skip_invalid @@ -42916,7 +42973,7 @@ def dimensiondefaults(self): The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - - An instance of plotly.graph_objs.parcoords.Dimension + - An instance of :class:`plotly.graph_objs.parcoords.Dimension` - A dict of string/value properties that will be passed to the Dimension constructor @@ -42939,7 +42996,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.parcoords.Domain + - An instance of :class:`plotly.graph_objs.parcoords.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -43045,7 +43102,7 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of plotly.graph_objs.parcoords.Labelfont + - An instance of :class:`plotly.graph_objs.parcoords.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor @@ -43112,7 +43169,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.parcoords.Line + - An instance of :class:`plotly.graph_objs.parcoords.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -43172,8 +43229,9 @@ def line(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcoords.line.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.Col + orBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The @@ -43293,7 +43351,7 @@ def rangefont(self): The 'rangefont' property is an instance of Rangefont that may be specified as: - - An instance of plotly.graph_objs.parcoords.Rangefont + - An instance of :class:`plotly.graph_objs.parcoords.Rangefont` - A dict of string/value properties that will be passed to the Rangefont constructor @@ -43336,7 +43394,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.parcoords.Stream + - An instance of :class:`plotly.graph_objs.parcoords.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -43371,7 +43429,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.parcoords.Tickfont + - An instance of :class:`plotly.graph_objs.parcoords.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -43518,8 +43576,8 @@ def _prop_descriptions(self): the default property values to use for elements of parcoords.dimensions domain - plotly.graph_objects.parcoords.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -43541,8 +43599,8 @@ def _prop_descriptions(self): may be positioned better inside margins when `labelposition` is set to "bottom". line - plotly.graph_objects.parcoords.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -43564,8 +43622,8 @@ def _prop_descriptions(self): rangefont Sets the font for the `dimension` range values. stream - plotly.graph_objects.parcoords.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid @@ -43633,7 +43691,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Parcoords + an instance of :class:`plotly.graph_objs.Parcoords` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -43650,8 +43708,8 @@ def __init__( the default property values to use for elements of parcoords.dimensions domain - plotly.graph_objects.parcoords.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -43673,8 +43731,8 @@ def __init__( may be positioned better inside margins when `labelposition` is set to "bottom". line - plotly.graph_objects.parcoords.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -43696,8 +43754,8 @@ def __init__( rangefont Sets the font for the `dimension` range values. stream - plotly.graph_objects.parcoords.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid @@ -43747,7 +43805,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Parcoords constructor must be a dict or -an instance of plotly.graph_objs.Parcoords""" +an instance of :class:`plotly.graph_objs.Parcoords`""" ) # Handle skip_invalid @@ -44027,7 +44085,7 @@ def dimensiondefaults(self): The 'dimensiondefaults' property is an instance of Dimension that may be specified as: - - An instance of plotly.graph_objs.parcats.Dimension + - An instance of :class:`plotly.graph_objs.parcats.Dimension` - A dict of string/value properties that will be passed to the Dimension constructor @@ -44050,7 +44108,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.parcats.Domain + - An instance of :class:`plotly.graph_objs.parcats.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -44180,7 +44238,7 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of plotly.graph_objs.parcats.Labelfont + - An instance of :class:`plotly.graph_objs.parcats.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor @@ -44223,7 +44281,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.parcats.Line + - An instance of :class:`plotly.graph_objs.parcats.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -44283,8 +44341,9 @@ def line(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcats.line.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.parcats.line.Color + Bar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The @@ -44458,7 +44517,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.parcats.Stream + - An instance of :class:`plotly.graph_objs.parcats.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -44493,7 +44552,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.parcats.Tickfont + - An instance of :class:`plotly.graph_objs.parcats.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -44649,8 +44708,8 @@ def _prop_descriptions(self): the default property values to use for elements of parcats.dimensions domain - plotly.graph_objects.parcats.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -44691,8 +44750,8 @@ def _prop_descriptions(self): labelfont Sets the font for the `dimension` labels. line - plotly.graph_objects.parcats.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -44717,8 +44776,8 @@ def _prop_descriptions(self): If `backward`, sort paths based on dimensions categories from right to left. stream - plotly.graph_objects.parcats.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties tickfont Sets the font for the `category` labels. uid @@ -44786,7 +44845,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Parcats + an instance of :class:`plotly.graph_objs.Parcats` arrangement Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only @@ -44812,8 +44871,8 @@ def __init__( the default property values to use for elements of parcats.dimensions domain - plotly.graph_objects.parcats.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -44854,8 +44913,8 @@ def __init__( labelfont Sets the font for the `dimension` labels. line - plotly.graph_objects.parcats.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -44880,8 +44939,8 @@ def __init__( If `backward`, sort paths based on dimensions categories from right to left. stream - plotly.graph_objects.parcats.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties tickfont Sets the font for the `category` labels. uid @@ -44931,7 +44990,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Parcats constructor must be a dict or -an instance of plotly.graph_objs.Parcats""" +an instance of :class:`plotly.graph_objs.Parcats`""" ) # Handle skip_invalid @@ -45128,15 +45187,15 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of plotly.graph_objs.ohlc.Decreasing + - An instance of :class:`plotly.graph_objs.ohlc.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor Supported dict properties: line - plotly.graph_objects.ohlc.decreasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.ohlc.decreasing.Li + ne` instance or dict with compatible properties Returns ------- @@ -45241,7 +45300,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.ohlc.Hoverlabel + - An instance of :class:`plotly.graph_objs.ohlc.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -45387,15 +45446,15 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of plotly.graph_objs.ohlc.Increasing + - An instance of :class:`plotly.graph_objs.ohlc.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor Supported dict properties: line - plotly.graph_objects.ohlc.increasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.ohlc.increasing.Li + ne` instance or dict with compatible properties Returns ------- @@ -45437,7 +45496,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.ohlc.Line + - An instance of :class:`plotly.graph_objs.ohlc.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -45689,7 +45748,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.ohlc.Stream + - An instance of :class:`plotly.graph_objs.ohlc.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -46003,8 +46062,8 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.ohlc.Decreasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties high Sets the high values. highsrc @@ -46017,8 +46076,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.ohlc.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -46030,15 +46089,15 @@ def _prop_descriptions(self): idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.ohlc.Increasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.ohlc.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties low Sets the low values. lowsrc @@ -46078,8 +46137,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.ohlc.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -46196,7 +46255,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Ohlc + an instance of :class:`plotly.graph_objs.Ohlc` close Sets the close values. closesrc @@ -46209,8 +46268,8 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.ohlc.Decreasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties high Sets the high values. highsrc @@ -46223,8 +46282,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.ohlc.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -46236,15 +46295,15 @@ def __init__( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.ohlc.Increasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.ohlc.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties low Sets the low values. lowsrc @@ -46284,8 +46343,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.ohlc.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -46360,7 +46419,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Ohlc constructor must be a dict or -an instance of plotly.graph_objs.Ohlc""" +an instance of :class:`plotly.graph_objs.Ohlc`""" ) # Handle skip_invalid @@ -46764,7 +46823,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.mesh3d.ColorBar + - An instance of :class:`plotly.graph_objs.mesh3d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -46896,9 +46955,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.mesh3d.colorbar - .Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.mesh3d. + colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.mesh3d.colorbar.tickformatstopdefaults), sets @@ -46944,8 +47003,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.mesh3d.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.mesh3d.colorbar.Ti + tle` instance or dict with compatible + properties titlefont Deprecated: Please use mesh3d.colorbar.title.font instead. Sets this @@ -47050,7 +47110,7 @@ def contour(self): """ The 'contour' property is an instance of Contour that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Contour + - An instance of :class:`plotly.graph_objs.mesh3d.Contour` - A dict of string/value properties that will be passed to the Contour constructor @@ -47257,7 +47317,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Hoverlabel + - An instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -47684,7 +47744,7 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Lighting + - An instance of :class:`plotly.graph_objs.mesh3d.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor @@ -47732,7 +47792,7 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Lightposition + - An instance of :class:`plotly.graph_objs.mesh3d.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor @@ -47949,7 +48009,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Stream + - An instance of :class:`plotly.graph_objs.mesh3d.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -48409,8 +48469,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.mesh3d.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -48424,8 +48484,8 @@ def _prop_descriptions(self): d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.mesh3d.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -48456,8 +48516,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.mesh3d.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -48540,11 +48600,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.mesh3d.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.mesh3d.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -48588,8 +48648,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.mesh3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -48738,7 +48798,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Mesh3d + an instance of :class:`plotly.graph_objs.Mesh3d` alphahull Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the @@ -48793,8 +48853,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.mesh3d.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -48808,8 +48868,8 @@ def __init__( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.mesh3d.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -48840,8 +48900,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.mesh3d.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -48924,11 +48984,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.mesh3d.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.mesh3d.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -48972,8 +49032,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.mesh3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -49060,7 +49120,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Mesh3d constructor must be a dict or -an instance of plotly.graph_objs.Mesh3d""" +an instance of :class:`plotly.graph_objs.Mesh3d`""" ) # Handle skip_invalid @@ -49325,21 +49385,21 @@ def caps(self): """ The 'caps' property is an instance of Caps that may be specified as: - - An instance of plotly.graph_objs.isosurface.Caps + - An instance of :class:`plotly.graph_objs.isosurface.Caps` - A dict of string/value properties that will be passed to the Caps constructor Supported dict properties: x - plotly.graph_objects.isosurface.caps.X instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.caps.X` + instance or dict with compatible properties y - plotly.graph_objects.isosurface.caps.Y instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Y` + instance or dict with compatible properties z - plotly.graph_objects.isosurface.caps.Z instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Z` + instance or dict with compatible properties Returns ------- @@ -49472,7 +49532,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.isosurface.ColorBar + - An instance of :class:`plotly.graph_objs.isosurface.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -49604,9 +49664,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.isosurface.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.isosurf + ace.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.isosurface.colorbar.tickformatstopdefaults), @@ -49652,8 +49712,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.isosurface.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use isosurface.colorbar.title.font instead. Sets @@ -49758,7 +49819,7 @@ def contour(self): """ The 'contour' property is an instance of Contour that may be specified as: - - An instance of plotly.graph_objs.isosurface.Contour + - An instance of :class:`plotly.graph_objs.isosurface.Contour` - A dict of string/value properties that will be passed to the Contour constructor @@ -49900,7 +49961,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.isosurface.Hoverlabel + - An instance of :class:`plotly.graph_objs.isosurface.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -50167,7 +50228,7 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of plotly.graph_objs.isosurface.Lighting + - An instance of :class:`plotly.graph_objs.isosurface.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor @@ -50215,7 +50276,7 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of plotly.graph_objs.isosurface.Lightposition + - An instance of :class:`plotly.graph_objs.isosurface.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor @@ -50432,21 +50493,21 @@ def slices(self): """ The 'slices' property is an instance of Slices that may be specified as: - - An instance of plotly.graph_objs.isosurface.Slices + - An instance of :class:`plotly.graph_objs.isosurface.Slices` - A dict of string/value properties that will be passed to the Slices constructor Supported dict properties: x - plotly.graph_objects.isosurface.slices.X - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices. + X` instance or dict with compatible properties y - plotly.graph_objects.isosurface.slices.Y - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices. + Y` instance or dict with compatible properties z - plotly.graph_objects.isosurface.slices.Z - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices. + Z` instance or dict with compatible properties Returns ------- @@ -50465,7 +50526,7 @@ def spaceframe(self): """ The 'spaceframe' property is an instance of Spaceframe that may be specified as: - - An instance of plotly.graph_objs.isosurface.Spaceframe + - An instance of :class:`plotly.graph_objs.isosurface.Spaceframe` - A dict of string/value properties that will be passed to the Spaceframe constructor @@ -50502,7 +50563,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.isosurface.Stream + - An instance of :class:`plotly.graph_objs.isosurface.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -50535,7 +50596,7 @@ def surface(self): """ The 'surface' property is an instance of Surface that may be specified as: - - An instance of plotly.graph_objs.isosurface.Surface + - An instance of :class:`plotly.graph_objs.isosurface.Surface` - A dict of string/value properties that will be passed to the Surface constructor @@ -50885,8 +50946,8 @@ def _prop_descriptions(self): chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.isosurface.Caps instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -50913,8 +50974,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.isosurface.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -50928,8 +50989,8 @@ def _prop_descriptions(self): d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.isosurface.Contour instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -50949,8 +51010,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.isosurface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -50996,11 +51057,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.isosurface.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.isosurface.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -51044,17 +51105,17 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.isosurface.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties spaceframe - plotly.graph_objects.isosurface.Spaceframe instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.isosurface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties surface - plotly.graph_objects.isosurface.Surface instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -51178,7 +51239,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Isosurface + an instance of :class:`plotly.graph_objs.Isosurface` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -51187,8 +51248,8 @@ def __init__( chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.isosurface.Caps instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -51215,8 +51276,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.isosurface.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -51230,8 +51291,8 @@ def __init__( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.isosurface.Contour instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -51251,8 +51312,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.isosurface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -51298,11 +51359,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.isosurface.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.isosurface.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -51346,17 +51407,17 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.isosurface.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties spaceframe - plotly.graph_objects.isosurface.Spaceframe instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.isosurface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties surface - plotly.graph_objects.isosurface.Surface instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -51427,7 +51488,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Isosurface constructor must be a dict or -an instance of plotly.graph_objs.Isosurface""" +an instance of :class:`plotly.graph_objs.Isosurface`""" ) # Handle skip_invalid @@ -51700,20 +51761,22 @@ def delta(self): """ The 'delta' property is an instance of Delta that may be specified as: - - An instance of plotly.graph_objs.indicator.Delta + - An instance of :class:`plotly.graph_objs.indicator.Delta` - A dict of string/value properties that will be passed to the Delta constructor Supported dict properties: decreasing - plotly.graph_objects.indicator.delta.Decreasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.De + creasing` instance or dict with compatible + properties font Set the font used to display the delta increasing - plotly.graph_objects.indicator.delta.Increasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.In + creasing` instance or dict with compatible + properties position Sets the position of delta with respect to the number. @@ -51746,7 +51809,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.indicator.Domain + - An instance of :class:`plotly.graph_objs.indicator.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -51785,15 +51848,15 @@ def gauge(self): The 'gauge' property is an instance of Gauge that may be specified as: - - An instance of plotly.graph_objs.indicator.Gauge + - An instance of :class:`plotly.graph_objs.indicator.Gauge` - A dict of string/value properties that will be passed to the Gauge constructor Supported dict properties: axis - plotly.graph_objects.indicator.gauge.Axis - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Ax + is` instance or dict with compatible properties bar Set the appearance of the gauge's value bgcolor @@ -51807,17 +51870,18 @@ def gauge(self): shape Set the shape of the gauge steps - A tuple of - plotly.graph_objects.indicator.gauge.Step - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.indicat + or.gauge.Step` instances or dicts with + compatible properties stepdefaults When used in a template (as layout.template.dat a.indicator.gauge.stepdefaults), sets the default property values to use for elements of indicator.gauge.steps threshold - plotly.graph_objects.indicator.gauge.Threshold - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Th + reshold` instance or dict with compatible + properties Returns ------- @@ -51973,7 +52037,7 @@ def number(self): """ The 'number' property is an instance of Number that may be specified as: - - An instance of plotly.graph_objs.indicator.Number + - An instance of :class:`plotly.graph_objs.indicator.Number` - A dict of string/value properties that will be passed to the Number constructor @@ -52009,7 +52073,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.indicator.Stream + - An instance of :class:`plotly.graph_objs.indicator.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -52042,7 +52106,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.indicator.Title + - An instance of :class:`plotly.graph_objs.indicator.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -52195,11 +52259,11 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . delta - plotly.graph_objects.indicator.Delta instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties domain - plotly.graph_objects.indicator.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties gauge The gauge of the Indicator plot. ids @@ -52233,14 +52297,14 @@ def _prop_descriptions(self): Sets the trace name. The trace name appear as the legend item and on hover. number - plotly.graph_objects.indicator.Number instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties stream - plotly.graph_objects.indicator.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties title - plotly.graph_objects.indicator.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -52310,7 +52374,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Indicator + an instance of :class:`plotly.graph_objs.Indicator` align Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an @@ -52324,11 +52388,11 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . delta - plotly.graph_objects.indicator.Delta instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties domain - plotly.graph_objects.indicator.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties gauge The gauge of the Indicator plot. ids @@ -52362,14 +52426,14 @@ def __init__( Sets the trace name. The trace name appear as the legend item and on hover. number - plotly.graph_objects.indicator.Number instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties stream - plotly.graph_objects.indicator.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties title - plotly.graph_objects.indicator.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -52419,7 +52483,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Indicator constructor must be a dict or -an instance of plotly.graph_objs.Indicator""" +an instance of :class:`plotly.graph_objs.Indicator`""" ) # Handle skip_invalid @@ -52676,7 +52740,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.image.Hoverlabel + - An instance of :class:`plotly.graph_objs.image.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -52968,7 +53032,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.image.Stream + - An instance of :class:`plotly.graph_objs.image.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -53347,8 +53411,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.image.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -53407,8 +53471,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. stream - plotly.graph_objects.image.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -53527,7 +53591,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Image + an instance of :class:`plotly.graph_objs.Image` colormodel Color model used to map the numerical color components described in `z` into colors. @@ -53550,8 +53614,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.image.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -53610,8 +53674,8 @@ def __init__( opacity Sets the opacity of the trace. stream - plotly.graph_objects.image.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -53697,7 +53761,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Image constructor must be a dict or -an instance of plotly.graph_objs.Image""" +an instance of :class:`plotly.graph_objs.Image`""" ) # Handle skip_invalid @@ -53988,7 +54052,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.ColorBar + - An instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -54120,9 +54184,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2dcont - our.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.histogr + am2dcontour.colorbar.Tickformatstop` instances + or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram2dcontour.colorbar.tickformatstopdef @@ -54169,9 +54233,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2dcontour.colorba - r.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.histogram2dcontour + .colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use histogram2dcontour.colorbar.title.font instead. @@ -54276,7 +54340,7 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Contours + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Contours` - A dict of string/value properties that will be passed to the Contours constructor @@ -54512,7 +54576,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Hoverlabel + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -54697,7 +54761,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Line + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -54735,7 +54799,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Marker + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -54990,7 +55054,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Stream + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -55171,7 +55235,7 @@ def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.XBins + - An instance of :class:`plotly.graph_objs.histogram2dcontour.XBins` - A dict of string/value properties that will be passed to the XBins constructor @@ -55343,7 +55407,7 @@ def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.YBins + - An instance of :class:`plotly.graph_objs.histogram2dcontour.YBins` - A dict of string/value properties that will be passed to the YBins constructor @@ -55643,8 +55707,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2dcontour.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -55658,8 +55722,8 @@ def _prop_descriptions(self): d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.histogram2dcontour.Contours - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -55700,8 +55764,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2dcontour.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -55740,11 +55804,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.histogram2dcontour.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties marker - plotly.graph_objects.histogram2dcontour.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -55794,8 +55858,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2dcontour.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -55838,8 +55902,8 @@ def _prop_descriptions(self): Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2dcontour.XBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -55859,8 +55923,8 @@ def _prop_descriptions(self): Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2dcontour.YBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -55969,7 +56033,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Histogram2dContour + an instance of + :class:`plotly.graph_objs.Histogram2dContour` autobinx Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobinx` is not needed. @@ -56007,8 +56072,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2dcontour.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -56022,8 +56087,8 @@ def __init__( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.histogram2dcontour.Contours - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -56064,8 +56129,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2dcontour.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -56104,11 +56169,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.histogram2dcontour.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties marker - plotly.graph_objects.histogram2dcontour.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -56158,8 +56223,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2dcontour.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -56202,8 +56267,8 @@ def __init__( Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2dcontour.XBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -56223,8 +56288,8 @@ def __init__( Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2dcontour.YBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -56276,7 +56341,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Histogram2dContour constructor must be a dict or -an instance of plotly.graph_objs.Histogram2dContour""" +an instance of :class:`plotly.graph_objs.Histogram2dContour`""" ) # Handle skip_invalid @@ -56626,7 +56691,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.histogram2d.ColorBar + - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -56758,9 +56823,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2d.col - orbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.histogr + am2d.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram2d.colorbar.tickformatstopdefaults), @@ -56807,8 +56872,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2d.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.colorb + ar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use histogram2d.colorbar.title.font instead. Sets @@ -57062,7 +57128,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.histogram2d.Hoverlabel + - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -57247,7 +57313,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.histogram2d.Marker + - An instance of :class:`plotly.graph_objs.histogram2d.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -57478,7 +57544,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.histogram2d.Stream + - An instance of :class:`plotly.graph_objs.histogram2d.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -57659,7 +57725,7 @@ def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - - An instance of plotly.graph_objs.histogram2d.XBins + - An instance of :class:`plotly.graph_objs.histogram2d.XBins` - A dict of string/value properties that will be passed to the XBins constructor @@ -57851,7 +57917,7 @@ def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - - An instance of plotly.graph_objs.histogram2d.YBins + - An instance of :class:`plotly.graph_objs.histogram2d.YBins` - A dict of string/value properties that will be passed to the YBins constructor @@ -58187,8 +58253,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2d.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -58241,8 +58307,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -58281,8 +58347,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram2d.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -58326,8 +58392,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2d.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -58370,8 +58436,8 @@ def _prop_descriptions(self): Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2d.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xgap @@ -58393,8 +58459,8 @@ def _prop_descriptions(self): Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2d.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ygap @@ -58506,7 +58572,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Histogram2d + an instance of :class:`plotly.graph_objs.Histogram2d` autobinx Obsolete: since v1.42 each bin attribute is auto- determined separately and `autobinx` is not needed. @@ -58539,8 +58605,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2d.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -58593,8 +58659,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -58633,8 +58699,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram2d.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -58678,8 +58744,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2d.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -58722,8 +58788,8 @@ def __init__( Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2d.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xgap @@ -58745,8 +58811,8 @@ def __init__( Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2d.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ygap @@ -58802,7 +58868,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Histogram2d constructor must be a dict or -an instance of plotly.graph_objs.Histogram2d""" +an instance of :class:`plotly.graph_objs.Histogram2d`""" ) # Handle skip_invalid @@ -59114,7 +59180,7 @@ def cumulative(self): """ The 'cumulative' property is an instance of Cumulative that may be specified as: - - An instance of plotly.graph_objs.histogram.Cumulative + - An instance of :class:`plotly.graph_objs.histogram.Cumulative` - A dict of string/value properties that will be passed to the Cumulative constructor @@ -59207,7 +59273,7 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of plotly.graph_objs.histogram.ErrorX + - An instance of :class:`plotly.graph_objs.histogram.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor @@ -59288,7 +59354,7 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of plotly.graph_objs.histogram.ErrorY + - An instance of :class:`plotly.graph_objs.histogram.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor @@ -59473,7 +59539,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.histogram.Hoverlabel + - An instance of :class:`plotly.graph_objs.histogram.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -59700,7 +59766,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.histogram.Marker + - An instance of :class:`plotly.graph_objs.histogram.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -59760,8 +59826,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -59782,8 +59849,9 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.histogram.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.L + ine` instance or dict with compatible + properties opacity Sets the opacity of the bars. opacitysrc @@ -60001,18 +60069,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.histogram.Selected + - An instance of :class:`plotly.graph_objs.histogram.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.histogram.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.selected + .Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.histogram.selected.Textfon - t instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.selected + .Textfont` instance or dict with compatible + properties Returns ------- @@ -60076,7 +60146,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.histogram.Stream + - An instance of :class:`plotly.graph_objs.histogram.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -60209,18 +60279,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.histogram.Unselected + - An instance of :class:`plotly.graph_objs.histogram.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.histogram.unselected.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselect + ed.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.histogram.unselected.Textf - ont instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselect + ed.Textfont` instance or dict with compatible + properties Returns ------- @@ -60307,7 +60379,7 @@ def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - - An instance of plotly.graph_objs.histogram.XBins + - An instance of :class:`plotly.graph_objs.histogram.XBins` - A dict of string/value properties that will be passed to the XBins constructor @@ -60464,7 +60536,7 @@ def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - - An instance of plotly.graph_objs.histogram.YBins + - An instance of :class:`plotly.graph_objs.histogram.YBins` - A dict of string/value properties that will be passed to the YBins constructor @@ -60613,8 +60685,8 @@ def _prop_descriptions(self): can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup` cumulative - plotly.graph_objects.histogram.Cumulative instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -60623,11 +60695,11 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.histogram.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.histogram.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by @@ -60661,8 +60733,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -60705,8 +60777,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -60748,8 +60820,8 @@ def _prop_descriptions(self): value of the each bar spans along the vertical (horizontal). selected - plotly.graph_objects.histogram.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -60761,8 +60833,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.histogram.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. @@ -60793,8 +60865,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.histogram.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -60808,8 +60880,8 @@ def _prop_descriptions(self): x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins - plotly.graph_objects.histogram.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -60822,8 +60894,8 @@ def _prop_descriptions(self): y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins - plotly.graph_objects.histogram.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -60898,7 +60970,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Histogram + an instance of :class:`plotly.graph_objs.Histogram` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls @@ -60926,8 +60998,8 @@ def __init__( can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup` cumulative - plotly.graph_objects.histogram.Cumulative instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -60936,11 +61008,11 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.histogram.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.histogram.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by @@ -60974,8 +61046,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -61018,8 +61090,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -61061,8 +61133,8 @@ def __init__( value of the each bar spans along the vertical (horizontal). selected - plotly.graph_objects.histogram.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -61074,8 +61146,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.histogram.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. @@ -61106,8 +61178,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.histogram.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -61121,8 +61193,8 @@ def __init__( x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins - plotly.graph_objects.histogram.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -61135,8 +61207,8 @@ def __init__( y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins - plotly.graph_objects.histogram.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -61161,7 +61233,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Histogram constructor must be a dict or -an instance of plotly.graph_objs.Histogram""" +an instance of :class:`plotly.graph_objs.Histogram`""" ) # Handle skip_invalid @@ -61414,7 +61486,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.ColorBar + - An instance of :class:`plotly.graph_objs.heatmapgl.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -61546,9 +61618,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.heatmapgl.color - bar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.heatmap + gl.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.heatmapgl.colorbar.tickformatstopdefaults), @@ -61594,8 +61666,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmapgl.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.colorbar + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use heatmapgl.colorbar.title.font instead. Sets @@ -61829,7 +61902,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.Hoverlabel + - An instance of :class:`plotly.graph_objs.heatmapgl.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -62063,7 +62136,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.Stream + - An instance of :class:`plotly.graph_objs.heatmapgl.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -62606,8 +62679,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmapgl.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -62639,8 +62712,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmapgl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -62675,8 +62748,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmapgl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmapgl.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -62828,7 +62901,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Heatmapgl + an instance of :class:`plotly.graph_objs.Heatmapgl` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -62844,8 +62917,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmapgl.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -62877,8 +62950,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmapgl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -62913,8 +62986,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmapgl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmapgl.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -63028,7 +63101,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Heatmapgl constructor must be a dict or -an instance of plotly.graph_objs.Heatmapgl""" +an instance of :class:`plotly.graph_objs.Heatmapgl`""" ) # Handle skip_invalid @@ -63255,7 +63328,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.heatmap.ColorBar + - An instance of :class:`plotly.graph_objs.heatmap.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -63387,9 +63460,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.heatmap.colorba - r.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.heatmap + .colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.heatmap.colorbar.tickformatstopdefaults), @@ -63435,8 +63508,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmap.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmap.colorbar.T + itle` instance or dict with compatible + properties titlefont Deprecated: Please use heatmap.colorbar.title.font instead. Sets this @@ -63693,7 +63767,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.heatmap.Hoverlabel + - An instance of :class:`plotly.graph_objs.heatmap.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -64093,7 +64167,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.heatmap.Stream + - An instance of :class:`plotly.graph_objs.heatmap.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -64769,8 +64843,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmap.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -64807,8 +64881,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -64884,8 +64958,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -65082,7 +65156,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Heatmap + an instance of :class:`plotly.graph_objs.Heatmap` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -65098,8 +65172,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmap.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -65136,8 +65210,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -65213,8 +65287,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -65343,7 +65417,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Heatmap constructor must be a dict or -an instance of plotly.graph_objs.Heatmap""" +an instance of :class:`plotly.graph_objs.Heatmap`""" ) # Handle skip_invalid @@ -65665,7 +65739,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Domain + - An instance of :class:`plotly.graph_objs.funnelarea.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -65749,7 +65823,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Hoverlabel + - An instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -65960,7 +66034,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Insidetextfont + - An instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -66102,7 +66176,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Marker + - An instance of :class:`plotly.graph_objs.funnelarea.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -66116,8 +66190,9 @@ def marker(self): Sets the source reference on plot.ly for colors . line - plotly.graph_objects.funnelarea.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.marker. + Line` instance or dict with compatible + properties Returns ------- @@ -66270,7 +66345,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Stream + - An instance of :class:`plotly.graph_objs.funnelarea.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -66329,7 +66404,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Textfont + - An instance of :class:`plotly.graph_objs.funnelarea.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -66523,7 +66598,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.funnelarea.Title + - An instance of :class:`plotly.graph_objs.funnelarea.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -66705,8 +66780,8 @@ def _prop_descriptions(self): dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.funnelarea.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -66715,8 +66790,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnelarea.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -66778,8 +66853,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnelarea.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -66809,8 +66884,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnelarea.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -66849,8 +66924,8 @@ def _prop_descriptions(self): Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.funnelarea.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -66945,7 +67020,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Funnelarea + an instance of :class:`plotly.graph_objs.Funnelarea` aspectratio Sets the ratio between height and width baseratio @@ -66961,8 +67036,8 @@ def __init__( dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.funnelarea.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -66971,8 +67046,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnelarea.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -67034,8 +67109,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnelarea.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -67065,8 +67140,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnelarea.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -67105,8 +67180,8 @@ def __init__( Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.funnelarea.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -67159,7 +67234,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Funnelarea constructor must be a dict or -an instance of plotly.graph_objs.Funnelarea""" +an instance of :class:`plotly.graph_objs.Funnelarea`""" ) # Handle skip_invalid @@ -67382,7 +67457,7 @@ def connector(self): """ The 'connector' property is an instance of Connector that may be specified as: - - An instance of plotly.graph_objs.funnel.Connector + - An instance of :class:`plotly.graph_objs.funnel.Connector` - A dict of string/value properties that will be passed to the Connector constructor @@ -67391,8 +67466,9 @@ def connector(self): fillcolor Sets the fill color. line - plotly.graph_objects.funnel.connector.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.connector.L + ine` instance or dict with compatible + properties visible Determines if connector regions and lines are drawn. @@ -67565,7 +67641,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.funnel.Hoverlabel + - An instance of :class:`plotly.graph_objs.funnel.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -67798,7 +67874,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.funnel.Insidetextfont + - An instance of :class:`plotly.graph_objs.funnel.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -67874,7 +67950,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.funnel.Marker + - An instance of :class:`plotly.graph_objs.funnel.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -67934,8 +68010,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.funnel.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.Colo + rBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -67956,8 +68033,8 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.funnel.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.Line + ` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -68155,7 +68232,7 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of plotly.graph_objs.funnel.Outsidetextfont + - An instance of :class:`plotly.graph_objs.funnel.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor @@ -68253,7 +68330,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.funnel.Stream + - An instance of :class:`plotly.graph_objs.funnel.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -68340,7 +68417,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.funnel.Textfont + - An instance of :class:`plotly.graph_objs.funnel.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -68833,8 +68910,8 @@ def _prop_descriptions(self): and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.funnel.Connector instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -68857,8 +68934,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnel.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -68912,8 +68989,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnel.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -68964,8 +69041,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnel.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -69150,7 +69227,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Funnel + an instance of :class:`plotly.graph_objs.Funnel` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls @@ -69162,8 +69239,8 @@ def __init__( and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.funnel.Connector instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -69186,8 +69263,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnel.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -69241,8 +69318,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnel.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -69293,8 +69370,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnel.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -69425,7 +69502,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Funnel constructor must be a dict or -an instance of plotly.graph_objs.Funnel""" +an instance of :class:`plotly.graph_objs.Funnel`""" ) # Handle skip_invalid @@ -69713,7 +69790,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.ColorBar + - An instance of :class:`plotly.graph_objs.densitymapbox.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -69845,9 +69922,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.densitymapbox.c - olorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.density + mapbox.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.densitymapbox.colorbar.tickformatstopdefaults @@ -69894,8 +69971,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.densitymapbox.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.colo + rbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use densitymapbox.colorbar.title.font instead. Sets @@ -70089,7 +70167,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.Hoverlabel + - An instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -70597,7 +70675,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.Stream + - An instance of :class:`plotly.graph_objs.densitymapbox.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -70939,8 +71017,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.densitymapbox.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -70968,8 +71046,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.densitymapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -71060,8 +71138,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.densitymapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -71189,7 +71267,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Densitymapbox + an instance of :class:`plotly.graph_objs.Densitymapbox` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -71211,8 +71289,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.densitymapbox.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -71240,8 +71318,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.densitymapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -71332,8 +71410,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.densitymapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -71420,7 +71498,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Densitymapbox constructor must be a dict or -an instance of plotly.graph_objs.Densitymapbox""" +an instance of :class:`plotly.graph_objs.Densitymapbox`""" ) # Handle skip_invalid @@ -71869,7 +71947,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.ColorBar + - An instance of :class:`plotly.graph_objs.contourcarpet.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -72001,9 +72079,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.contourcarpet.c - olorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.contour + carpet.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.contourcarpet.colorbar.tickformatstopdefaults @@ -72050,8 +72128,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.contourcarpet.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.colo + rbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use contourcarpet.colorbar.title.font instead. Sets @@ -72156,7 +72235,7 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.Contours + - An instance of :class:`plotly.graph_objs.contourcarpet.Contours` - A dict of string/value properties that will be passed to the Contours constructor @@ -72492,7 +72571,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.Line + - An instance of :class:`plotly.graph_objs.contourcarpet.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -72711,7 +72790,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.Stream + - An instance of :class:`plotly.graph_objs.contourcarpet.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -73120,8 +73199,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contourcarpet.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -73135,8 +73214,8 @@ def _prop_descriptions(self): d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.contourcarpet.Contours instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -73168,8 +73247,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contourcarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -73207,8 +73286,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contourcarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -73341,7 +73420,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Contourcarpet + an instance of :class:`plotly.graph_objs.Contourcarpet` a Sets the x coordinates. a0 @@ -73393,8 +73472,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contourcarpet.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -73408,8 +73487,8 @@ def __init__( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.contourcarpet.Contours instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -73441,8 +73520,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contourcarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -73480,8 +73559,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contourcarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -73567,7 +73646,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Contourcarpet constructor must be a dict or -an instance of plotly.graph_objs.Contourcarpet""" +an instance of :class:`plotly.graph_objs.Contourcarpet`""" ) # Handle skip_invalid @@ -73838,7 +73917,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.contour.ColorBar + - An instance of :class:`plotly.graph_objs.contour.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -73970,9 +74049,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.contour.colorba - r.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.contour + .colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.contour.colorbar.tickformatstopdefaults), @@ -74018,8 +74097,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.contour.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.contour.colorbar.T + itle` instance or dict with compatible + properties titlefont Deprecated: Please use contour.colorbar.title.font instead. Sets this @@ -74146,7 +74226,7 @@ def contours(self): """ The 'contours' property is an instance of Contours that may be specified as: - - An instance of plotly.graph_objs.contour.Contours + - An instance of :class:`plotly.graph_objs.contour.Contours` - A dict of string/value properties that will be passed to the Contours constructor @@ -74425,7 +74505,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.contour.Hoverlabel + - An instance of :class:`plotly.graph_objs.contour.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -74671,7 +74751,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.contour.Line + - An instance of :class:`plotly.graph_objs.contour.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -74890,7 +74970,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.contour.Stream + - An instance of :class:`plotly.graph_objs.contour.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -75510,8 +75590,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contour.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -75530,8 +75610,8 @@ def _prop_descriptions(self): to true if `z` is a one dimensional array otherwise it is defaulted to false. contours - plotly.graph_objects.contour.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -75556,8 +75636,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.contour.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -75603,8 +75683,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contour.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -75642,8 +75722,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contour.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -75826,7 +75906,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Contour + an instance of :class:`plotly.graph_objs.Contour` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -75847,8 +75927,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contour.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -75867,8 +75947,8 @@ def __init__( to true if `z` is a one dimensional array otherwise it is defaulted to false. contours - plotly.graph_objects.contour.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -75893,8 +75973,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.contour.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -75940,8 +76020,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contour.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -75979,8 +76059,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contour.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -76103,7 +76183,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Contour constructor must be a dict or -an instance of plotly.graph_objs.Contour""" +an instance of :class:`plotly.graph_objs.Contour`""" ) # Handle skip_invalid @@ -76493,7 +76573,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.cone.ColorBar + - An instance of :class:`plotly.graph_objs.cone.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -76625,8 +76705,8 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.cone.colorbar.T - ickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.cone.co + lorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat @@ -76673,8 +76753,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.cone.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.cone.colorbar.Titl + e` instance or dict with compatible properties titlefont Deprecated: Please use cone.colorbar.title.font instead. Sets this color bar's title font. Note @@ -76866,7 +76946,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.cone.Hoverlabel + - An instance of :class:`plotly.graph_objs.cone.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -77093,7 +77173,7 @@ def lighting(self): """ The 'lighting' property is an instance of Lighting that may be specified as: - - An instance of plotly.graph_objs.cone.Lighting + - An instance of :class:`plotly.graph_objs.cone.Lighting` - A dict of string/value properties that will be passed to the Lighting constructor @@ -77141,7 +77221,7 @@ def lightposition(self): """ The 'lightposition' property is an instance of Lightposition that may be specified as: - - An instance of plotly.graph_objs.cone.Lightposition + - An instance of :class:`plotly.graph_objs.cone.Lightposition` - A dict of string/value properties that will be passed to the Lightposition constructor @@ -77411,7 +77491,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.cone.Stream + - An instance of :class:`plotly.graph_objs.cone.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -77856,8 +77936,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.cone.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -77885,8 +77965,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.cone.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -77929,11 +78009,11 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.cone.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objects.cone.Lightposition instance or + :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -77994,8 +78074,8 @@ def _prop_descriptions(self): the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. stream - plotly.graph_objects.cone.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and @@ -78127,7 +78207,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Cone + an instance of :class:`plotly.graph_objs.Cone` anchor Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of @@ -78165,8 +78245,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.cone.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -78194,8 +78274,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.cone.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -78238,11 +78318,11 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.cone.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objects.cone.Lightposition instance or + :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -78303,8 +78383,8 @@ def __init__( the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. stream - plotly.graph_objects.cone.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and @@ -78386,7 +78466,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Cone constructor must be a dict or -an instance of plotly.graph_objs.Cone""" +an instance of :class:`plotly.graph_objs.Cone`""" ) # Handle skip_invalid @@ -78666,7 +78746,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.ColorBar + - An instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -78798,9 +78878,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.choroplethmapbo - x.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.choropl + ethmapbox.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.choroplethmapbox.colorbar.tickformatstopdefau @@ -78847,8 +78927,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.choroplethmapbox.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.choroplethmapbox.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -79088,7 +79168,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.Hoverlabel + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -79356,15 +79436,16 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.Marker + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: line - plotly.graph_objects.choroplethmapbox.marker.Li - ne instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.m + arker.Line` instance or dict with compatible + properties opacity Sets the opacity of the locations. opacitysrc @@ -79480,16 +79561,16 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.Selected + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.choroplethmapbox.selected. - Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.choroplethmapbox.s + elected.Marker` instance or dict with + compatible properties Returns ------- @@ -79574,7 +79655,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.Stream + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -79729,16 +79810,16 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.Unselected + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.choroplethmapbox.unselecte - d.Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.choroplethmapbox.u + nselected.Marker` instance or dict with + compatible properties Returns ------- @@ -79938,8 +80019,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choroplethmapbox.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -79977,8 +80058,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choroplethmapbox.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -80026,8 +80107,8 @@ def _prop_descriptions(self): locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choroplethmapbox.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -80051,8 +80132,8 @@ def _prop_descriptions(self): will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choroplethmapbox.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -80067,8 +80148,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choroplethmapbox.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -80101,8 +80182,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choroplethmapbox.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -80192,7 +80273,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Choroplethmapbox + an instance of + :class:`plotly.graph_objs.Choroplethmapbox` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -80214,8 +80296,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choroplethmapbox.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -80253,8 +80335,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choroplethmapbox.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -80302,8 +80384,8 @@ def __init__( locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choroplethmapbox.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -80327,8 +80409,8 @@ def __init__( will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choroplethmapbox.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -80343,8 +80425,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choroplethmapbox.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -80377,8 +80459,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choroplethmapbox.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -80426,7 +80508,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Choroplethmapbox constructor must be a dict or -an instance of plotly.graph_objs.Choroplethmapbox""" +an instance of :class:`plotly.graph_objs.Choroplethmapbox`""" ) # Handle skip_invalid @@ -80667,7 +80749,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.choropleth.ColorBar + - An instance of :class:`plotly.graph_objs.choropleth.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -80799,9 +80881,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.choropleth.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.choropl + eth.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.choropleth.colorbar.tickformatstopdefaults), @@ -80847,8 +80929,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.choropleth.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use choropleth.colorbar.title.font instead. Sets @@ -81114,7 +81197,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.choropleth.Hoverlabel + - An instance of :class:`plotly.graph_objs.choropleth.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -81407,15 +81490,16 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.choropleth.Marker + - An instance of :class:`plotly.graph_objs.choropleth.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: line - plotly.graph_objects.choropleth.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.marker. + Line` instance or dict with compatible + properties opacity Sets the opacity of the locations. opacitysrc @@ -81531,15 +81615,16 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.choropleth.Selected + - An instance of :class:`plotly.graph_objs.choropleth.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.choropleth.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.selecte + d.Marker` instance or dict with compatible + properties Returns ------- @@ -81624,7 +81709,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.choropleth.Stream + - An instance of :class:`plotly.graph_objs.choropleth.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -81754,15 +81839,16 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.choropleth.Unselected + - An instance of :class:`plotly.graph_objs.choropleth.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.choropleth.unselected.Mark - er instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.unselec + ted.Marker` instance or dict with compatible + properties Returns ------- @@ -81956,8 +82042,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choropleth.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -82003,8 +82089,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choropleth.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -82058,8 +82144,8 @@ def _prop_descriptions(self): locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choropleth.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -82083,8 +82169,8 @@ def _prop_descriptions(self): will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choropleth.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -82099,8 +82185,8 @@ def _prop_descriptions(self): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choropleth.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties text Sets the text elements associated with each location. textsrc @@ -82128,8 +82214,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choropleth.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -82219,7 +82305,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Choropleth + an instance of :class:`plotly.graph_objs.Choropleth` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -82235,8 +82321,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choropleth.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -82282,8 +82368,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choropleth.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -82337,8 +82423,8 @@ def __init__( locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choropleth.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -82362,8 +82448,8 @@ def __init__( will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choropleth.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -82378,8 +82464,8 @@ def __init__( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choropleth.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties text Sets the text elements associated with each location. textsrc @@ -82407,8 +82493,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choropleth.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -82456,7 +82542,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Choropleth constructor must be a dict or -an instance of plotly.graph_objs.Choropleth""" +an instance of :class:`plotly.graph_objs.Choropleth`""" ) # Handle skip_invalid @@ -82681,7 +82767,7 @@ def aaxis(self): """ The 'aaxis' property is an instance of Aaxis that may be specified as: - - An instance of plotly.graph_objs.carpet.Aaxis + - An instance of :class:`plotly.graph_objs.carpet.Aaxis` - A dict of string/value properties that will be passed to the Aaxis constructor @@ -82849,9 +82935,9 @@ def aaxis(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.carpet.aaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.carpet. + aaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.carpet.aaxis.tickformatstopdefaults), sets @@ -82879,8 +82965,8 @@ def aaxis(self): Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.aaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.carpet.aaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use carpet.aaxis.title.font instead. Sets this axis' title font. Note that @@ -82978,7 +83064,7 @@ def baxis(self): """ The 'baxis' property is an instance of Baxis that may be specified as: - - An instance of plotly.graph_objs.carpet.Baxis + - An instance of :class:`plotly.graph_objs.carpet.Baxis` - A dict of string/value properties that will be passed to the Baxis constructor @@ -83146,9 +83232,9 @@ def baxis(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.carpet.baxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.carpet. + baxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.carpet.baxis.tickformatstopdefaults), sets @@ -83176,8 +83262,8 @@ def baxis(self): Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.baxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.carpet.baxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use carpet.baxis.title.font instead. Sets this axis' title font. Note that @@ -83424,7 +83510,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.carpet.Font + - An instance of :class:`plotly.graph_objs.carpet.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -83599,7 +83685,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.carpet.Stream + - An instance of :class:`plotly.graph_objs.carpet.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -83859,8 +83945,8 @@ def _prop_descriptions(self): coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis - plotly.graph_objects.carpet.Aaxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties asrc Sets the source reference on plot.ly for a . b @@ -83871,8 +83957,8 @@ def _prop_descriptions(self): coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis - plotly.graph_objects.carpet.Baxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet @@ -83929,8 +84015,8 @@ def _prop_descriptions(self): opacity Sets the opacity of the trace. stream - plotly.graph_objects.carpet.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -84032,7 +84118,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Carpet + an instance of :class:`plotly.graph_objs.Carpet` a An array containing values of the first parameter value a0 @@ -84040,8 +84126,8 @@ def __init__( coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis - plotly.graph_objects.carpet.Aaxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties asrc Sets the source reference on plot.ly for a . b @@ -84052,8 +84138,8 @@ def __init__( coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis - plotly.graph_objects.carpet.Baxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet @@ -84110,8 +84196,8 @@ def __init__( opacity Sets the opacity of the trace. stream - plotly.graph_objects.carpet.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -84180,7 +84266,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Carpet constructor must be a dict or -an instance of plotly.graph_objs.Carpet""" +an instance of :class:`plotly.graph_objs.Carpet`""" ) # Handle skip_invalid @@ -84408,7 +84494,7 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of plotly.graph_objs.candlestick.Decreasing + - An instance of :class:`plotly.graph_objs.candlestick.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor @@ -84420,8 +84506,9 @@ def decreasing(self): color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.decreasing.Lin - e instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.decrea + sing.Line` instance or dict with compatible + properties Returns ------- @@ -84526,7 +84613,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.candlestick.Hoverlabel + - An instance of :class:`plotly.graph_objs.candlestick.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -84672,7 +84759,7 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of plotly.graph_objs.candlestick.Increasing + - An instance of :class:`plotly.graph_objs.candlestick.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor @@ -84684,8 +84771,9 @@ def increasing(self): color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.increasing.Lin - e instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.increa + sing.Line` instance or dict with compatible + properties Returns ------- @@ -84727,7 +84815,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.candlestick.Line + - An instance of :class:`plotly.graph_objs.candlestick.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -84972,7 +85060,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.candlestick.Stream + - An instance of :class:`plotly.graph_objs.candlestick.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -85286,8 +85374,8 @@ def _prop_descriptions(self): customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.candlestick.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties high Sets the high values. highsrc @@ -85300,8 +85388,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.candlestick.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -85313,15 +85401,15 @@ def _prop_descriptions(self): idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.candlestick.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.candlestick.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties low Sets the low values. lowsrc @@ -85361,8 +85449,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.candlestick.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -85480,7 +85568,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Candlestick + an instance of :class:`plotly.graph_objs.Candlestick` close Sets the close values. closesrc @@ -85493,8 +85581,8 @@ def __init__( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.candlestick.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties high Sets the high values. highsrc @@ -85507,8 +85595,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.candlestick.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -85520,15 +85608,15 @@ def __init__( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.candlestick.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.candlestick.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties low Sets the low values. lowsrc @@ -85568,8 +85656,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.candlestick.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -85645,7 +85733,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Candlestick constructor must be a dict or -an instance of plotly.graph_objs.Candlestick""" +an instance of :class:`plotly.graph_objs.Candlestick`""" ) # Handle skip_invalid @@ -86079,7 +86167,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.box.Hoverlabel + - An instance of :class:`plotly.graph_objs.box.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -86352,7 +86440,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.box.Line + - An instance of :class:`plotly.graph_objs.box.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -86425,7 +86513,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.box.Marker + - An instance of :class:`plotly.graph_objs.box.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -86438,8 +86526,8 @@ def marker(self): and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.box.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.box.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -86969,15 +87057,15 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.box.Selected + - An instance of :class:`plotly.graph_objs.box.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.box.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.box.selected.Marke + r` instance or dict with compatible properties Returns ------- @@ -87041,7 +87129,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.box.Stream + - An instance of :class:`plotly.graph_objs.box.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -87175,15 +87263,16 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.box.Unselected + - An instance of :class:`plotly.graph_objs.box.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.box.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.box.unselected.Mar + ker` instance or dict with compatible + properties Returns ------- @@ -87591,8 +87680,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.box.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? @@ -87642,8 +87731,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.box.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute @@ -87654,8 +87743,8 @@ def _prop_descriptions(self): lowerfencesrc Sets the source reference on plot.ly for lowerfence . marker - plotly.graph_objects.box.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect @@ -87764,8 +87853,8 @@ def _prop_descriptions(self): sdsrc Sets the source reference on plot.ly for sd . selected - plotly.graph_objects.box.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -87777,8 +87866,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.box.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -87811,8 +87900,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.box.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute @@ -87977,7 +88066,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Box + an instance of :class:`plotly.graph_objs.Box` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls @@ -88025,8 +88114,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.box.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? @@ -88076,8 +88165,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.box.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute @@ -88088,8 +88177,8 @@ def __init__( lowerfencesrc Sets the source reference on plot.ly for lowerfence . marker - plotly.graph_objects.box.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect @@ -88198,8 +88287,8 @@ def __init__( sdsrc Sets the source reference on plot.ly for sd . selected - plotly.graph_objects.box.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -88211,8 +88300,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.box.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -88245,8 +88334,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.box.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute @@ -88322,7 +88411,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Box constructor must be a dict or -an instance of plotly.graph_objs.Box""" +an instance of :class:`plotly.graph_objs.Box`""" ) # Handle skip_invalid @@ -88755,7 +88844,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.barpolar.Hoverlabel + - An instance of :class:`plotly.graph_objs.barpolar.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -88982,7 +89071,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.barpolar.Marker + - An instance of :class:`plotly.graph_objs.barpolar.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -89042,8 +89131,9 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.barpolar.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.Co + lorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -89064,8 +89154,8 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.barpolar.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.Li + ne` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -89293,18 +89383,20 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.barpolar.Selected + - An instance of :class:`plotly.graph_objs.barpolar.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.barpolar.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.selected. + Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.barpolar.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.selected. + Textfont` instance or dict with compatible + properties Returns ------- @@ -89368,7 +89460,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.barpolar.Stream + - An instance of :class:`plotly.graph_objs.barpolar.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -89609,18 +89701,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.barpolar.Unselected + - An instance of :class:`plotly.graph_objs.barpolar.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.barpolar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselecte + d.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.barpolar.unselected.Textfo - nt instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselecte + d.Textfont` instance or dict with compatible + properties Returns ------- @@ -89740,8 +89834,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.barpolar.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -89783,8 +89877,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.barpolar.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -89819,8 +89913,8 @@ def _prop_descriptions(self): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.barpolar.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -89832,8 +89926,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.barpolar.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -89880,8 +89974,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.barpolar.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -89951,7 +90045,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Barpolar + an instance of :class:`plotly.graph_objs.Barpolar` base Sets where the bar base is drawn (in radial axis units). In "stack" barmode, traces that set "base" will @@ -89979,8 +90073,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.barpolar.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -90022,8 +90116,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.barpolar.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -90058,8 +90152,8 @@ def __init__( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.barpolar.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -90071,8 +90165,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.barpolar.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -90119,8 +90213,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.barpolar.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -90150,7 +90244,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Barpolar constructor must be a dict or -an instance of plotly.graph_objs.Barpolar""" +an instance of :class:`plotly.graph_objs.Barpolar`""" ) # Handle skip_invalid @@ -90522,7 +90616,7 @@ def error_x(self): """ The 'error_x' property is an instance of ErrorX that may be specified as: - - An instance of plotly.graph_objs.bar.ErrorX + - An instance of :class:`plotly.graph_objs.bar.ErrorX` - A dict of string/value properties that will be passed to the ErrorX constructor @@ -90603,7 +90697,7 @@ def error_y(self): """ The 'error_y' property is an instance of ErrorY that may be specified as: - - An instance of plotly.graph_objs.bar.ErrorY + - An instance of :class:`plotly.graph_objs.bar.ErrorY` - A dict of string/value properties that will be passed to the ErrorY constructor @@ -90728,7 +90822,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.bar.Hoverlabel + - An instance of :class:`plotly.graph_objs.bar.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -90960,7 +91054,7 @@ def insidetextfont(self): The 'insidetextfont' property is an instance of Insidetextfont that may be specified as: - - An instance of plotly.graph_objs.bar.Insidetextfont + - An instance of :class:`plotly.graph_objs.bar.Insidetextfont` - A dict of string/value properties that will be passed to the Insidetextfont constructor @@ -91036,7 +91130,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.bar.Marker + - An instance of :class:`plotly.graph_objs.bar.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -91096,8 +91190,8 @@ def marker(self): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.bar.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -91118,8 +91212,8 @@ def marker(self): Sets the source reference on plot.ly for color . line - plotly.graph_objects.bar.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -91334,7 +91428,7 @@ def outsidetextfont(self): The 'outsidetextfont' property is an instance of Outsidetextfont that may be specified as: - - An instance of plotly.graph_objs.bar.Outsidetextfont + - An instance of :class:`plotly.graph_objs.bar.Outsidetextfont` - A dict of string/value properties that will be passed to the Outsidetextfont constructor @@ -91429,18 +91523,19 @@ def selected(self): """ The 'selected' property is an instance of Selected that may be specified as: - - An instance of plotly.graph_objs.bar.Selected + - An instance of :class:`plotly.graph_objs.bar.Selected` - A dict of string/value properties that will be passed to the Selected constructor Supported dict properties: marker - plotly.graph_objects.bar.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Marke + r` instance or dict with compatible properties textfont - plotly.graph_objects.bar.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Textf + ont` instance or dict with compatible + properties Returns ------- @@ -91504,7 +91599,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.bar.Stream + - An instance of :class:`plotly.graph_objs.bar.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -91613,7 +91708,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.bar.Textfont + - An instance of :class:`plotly.graph_objs.bar.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -91864,18 +91959,20 @@ def unselected(self): """ The 'unselected' property is an instance of Unselected that may be specified as: - - An instance of plotly.graph_objs.bar.Unselected + - An instance of :class:`plotly.graph_objs.bar.Unselected` - A dict of string/value properties that will be passed to the Unselected constructor Supported dict properties: marker - plotly.graph_objects.bar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Mar + ker` instance or dict with compatible + properties textfont - plotly.graph_objects.bar.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Tex + tfont` instance or dict with compatible + properties Returns ------- @@ -92220,11 +92317,11 @@ def _prop_descriptions(self): dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.bar.ErrorX instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties error_y - plotly.graph_objects.bar.ErrorY instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -92233,8 +92330,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.bar.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -92287,8 +92384,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.bar.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -92333,8 +92430,8 @@ def _prop_descriptions(self): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.bar.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -92346,8 +92443,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.bar.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -92427,8 +92524,8 @@ def _prop_descriptions(self): preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.bar.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -92552,7 +92649,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Bar + an instance of :class:`plotly.graph_objs.Bar` alignmentgroup Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls @@ -92585,11 +92682,11 @@ def __init__( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.bar.ErrorX instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties error_y - plotly.graph_objects.bar.ErrorY instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -92598,8 +92695,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.bar.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -92652,8 +92749,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.bar.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -92698,8 +92795,8 @@ def __init__( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.bar.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -92711,8 +92808,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.bar.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -92792,8 +92889,8 @@ def __init__( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.bar.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -92853,7 +92950,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Bar constructor must be a dict or -an instance of plotly.graph_objs.Bar""" +an instance of :class:`plotly.graph_objs.Bar`""" ) # Handle skip_invalid @@ -93190,7 +93287,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.area.Hoverlabel + - An instance of :class:`plotly.graph_objs.area.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -93314,7 +93411,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.area.Marker + - An instance of :class:`plotly.graph_objs.area.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -93527,7 +93624,7 @@ def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - - An instance of plotly.graph_objs.area.Stream + - An instance of :class:`plotly.graph_objs.area.Stream` - A dict of string/value properties that will be passed to the Stream constructor @@ -93705,8 +93802,8 @@ def _prop_descriptions(self): hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.area.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.area.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -93718,8 +93815,8 @@ def _prop_descriptions(self): the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.area.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -93750,8 +93847,8 @@ def _prop_descriptions(self): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.area.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Stream` instance or + dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for @@ -93821,7 +93918,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Area + an instance of :class:`plotly.graph_objs.Area` customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -93837,8 +93934,8 @@ def __init__( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.area.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.area.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -93850,8 +93947,8 @@ def __init__( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.area.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -93882,8 +93979,8 @@ def __init__( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.area.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Stream` instance or + dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for @@ -93937,7 +94034,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Area constructor must be a dict or -an instance of plotly.graph_objs.Area""" +an instance of :class:`plotly.graph_objs.Area`""" ) # Handle skip_invalid @@ -94101,7 +94198,7 @@ def angularaxis(self): """ The 'angularaxis' property is an instance of AngularAxis that may be specified as: - - An instance of plotly.graph_objs.layout.AngularAxis + - An instance of :class:`plotly.graph_objs.layout.AngularAxis` - A dict of string/value properties that will be passed to the AngularAxis constructor @@ -94270,8 +94367,9 @@ def annotations(self): (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.annotation.Hoverlab - el instance or dict with compatible properties + :class:`plotly.graph_objects.layout.annotation. + Hoverlabel` instance or dict with compatible + properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label @@ -94454,7 +94552,7 @@ def annotationdefaults(self): The 'annotationdefaults' property is an instance of Annotation that may be specified as: - - An instance of plotly.graph_objs.layout.Annotation + - An instance of :class:`plotly.graph_objs.layout.Annotation` - A dict of string/value properties that will be passed to the Annotation constructor @@ -94725,7 +94823,7 @@ def coloraxis(self): """ The 'coloraxis' property is an instance of Coloraxis that may be specified as: - - An instance of plotly.graph_objs.layout.Coloraxis + - An instance of :class:`plotly.graph_objs.layout.Coloraxis` - A dict of string/value properties that will be passed to the Coloraxis constructor @@ -94763,8 +94861,9 @@ def coloraxis(self): trace color array(s) and if set, `cmax` must be set as well. colorbar - plotly.graph_objects.layout.coloraxis.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.coloraxis.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -94805,7 +94904,7 @@ def colorscale(self): """ The 'colorscale' property is an instance of Colorscale that may be specified as: - - An instance of plotly.graph_objs.layout.Colorscale + - An instance of :class:`plotly.graph_objs.layout.Colorscale` - A dict of string/value properties that will be passed to the Colorscale constructor @@ -95065,7 +95164,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.Font + - An instance of :class:`plotly.graph_objs.layout.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -95200,7 +95299,7 @@ def geo(self): """ The 'geo' property is an instance of Geo that may be specified as: - - An instance of plotly.graph_objs.layout.Geo + - An instance of :class:`plotly.graph_objs.layout.Geo` - A dict of string/value properties that will be passed to the Geo constructor @@ -95209,8 +95308,8 @@ def geo(self): bgcolor Set the background color of the map center - plotly.graph_objects.layout.geo.Center instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Center` + instance or dict with compatible properties coastlinecolor Sets the coastline color. coastlinewidth @@ -95221,8 +95320,8 @@ def geo(self): Sets line width (in px) of the country boundaries. domain - plotly.graph_objects.layout.geo.Domain instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Domain` + instance or dict with compatible properties fitbounds Determines if this subplot's view settings are auto-computed to fit trace data. On scoped @@ -95251,16 +95350,17 @@ def geo(self): landcolor Sets the land mass color. lataxis - plotly.graph_objects.layout.geo.Lataxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lataxis + ` instance or dict with compatible properties lonaxis - plotly.graph_objects.layout.geo.Lonaxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lonaxis + ` instance or dict with compatible properties oceancolor Sets the ocean color projection - plotly.graph_objects.layout.geo.Projection - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Project + ion` instance or dict with compatible + properties resolution Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds @@ -95321,7 +95421,7 @@ def grid(self): """ The 'grid' property is an instance of Grid that may be specified as: - - An instance of plotly.graph_objs.layout.Grid + - An instance of :class:`plotly.graph_objs.layout.Grid` - A dict of string/value properties that will be passed to the Grid constructor @@ -95336,8 +95436,8 @@ def grid(self): different length, if you want to leave a row at the end for non-cartesian subplots. domain - plotly.graph_objects.layout.grid.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.grid.Domain + ` instance or dict with compatible properties pattern If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can @@ -95537,7 +95637,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.layout.Hoverlabel + - An instance of :class:`plotly.graph_objs.layout.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -95716,7 +95816,7 @@ def imagedefaults(self): The 'imagedefaults' property is an instance of Image that may be specified as: - - An instance of plotly.graph_objs.layout.Image + - An instance of :class:`plotly.graph_objs.layout.Image` - A dict of string/value properties that will be passed to the Image constructor @@ -95739,7 +95839,7 @@ def legend(self): """ The 'legend' property is an instance of Legend that may be specified as: - - An instance of plotly.graph_objs.layout.Legend + - An instance of :class:`plotly.graph_objs.layout.Legend` - A dict of string/value properties that will be passed to the Legend constructor @@ -95778,8 +95878,8 @@ def legend(self): orientation Sets the orientation of the legend. title - plotly.graph_objects.layout.legend.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.legend.Titl + e` instance or dict with compatible properties tracegroupgap Sets the amount of vertical space (in px) between legend groups. @@ -95848,7 +95948,7 @@ def mapbox(self): """ The 'mapbox' property is an instance of Mapbox that may be specified as: - - An instance of plotly.graph_objs.layout.Mapbox + - An instance of :class:`plotly.graph_objs.layout.Mapbox` - A dict of string/value properties that will be passed to the Mapbox constructor @@ -95867,15 +95967,15 @@ def mapbox(self): Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing). center - plotly.graph_objects.layout.mapbox.Center - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Cent + er` instance or dict with compatible properties domain - plotly.graph_objects.layout.mapbox.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Doma + in` instance or dict with compatible properties layers - A tuple of - plotly.graph_objects.layout.mapbox.Layer - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + mapbox.Layer` instances or dicts with + compatible properties layerdefaults When used in a template (as layout.template.layout.mapbox.layerdefaults), @@ -95938,7 +96038,7 @@ def margin(self): """ The 'margin' property is an instance of Margin that may be specified as: - - An instance of plotly.graph_objs.layout.Margin + - An instance of :class:`plotly.graph_objs.layout.Margin` - A dict of string/value properties that will be passed to the Margin constructor @@ -96024,7 +96124,7 @@ def modebar(self): """ The 'modebar' property is an instance of Modebar that may be specified as: - - An instance of plotly.graph_objs.layout.Modebar + - An instance of :class:`plotly.graph_objs.layout.Modebar` - A dict of string/value properties that will be passed to the Modebar constructor @@ -96231,15 +96331,16 @@ def polar(self): """ The 'polar' property is an instance of Polar that may be specified as: - - An instance of plotly.graph_objs.layout.Polar + - An instance of :class:`plotly.graph_objs.layout.Polar` - A dict of string/value properties that will be passed to the Polar constructor Supported dict properties: angularaxis - plotly.graph_objects.layout.polar.AngularAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Angul + arAxis` instance or dict with compatible + properties bargap Sets the gap between bars of adjacent location coordinates. Values are unitless, they @@ -96255,8 +96356,8 @@ def polar(self): bgcolor Set the background color of the subplot domain - plotly.graph_objects.layout.polar.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Domai + n` instance or dict with compatible properties gridshape Determines if the radial axis grid lines and angular axis line are drawn as "circular" @@ -96270,8 +96371,9 @@ def polar(self): Sets the fraction of the radius to cut out of the polar subplot. radialaxis - plotly.graph_objects.layout.polar.RadialAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Radia + lAxis` instance or dict with compatible + properties sector Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to @@ -96301,7 +96403,7 @@ def radialaxis(self): """ The 'radialaxis' property is an instance of RadialAxis that may be specified as: - - An instance of plotly.graph_objs.layout.RadialAxis + - An instance of :class:`plotly.graph_objs.layout.RadialAxis` - A dict of string/value properties that will be passed to the RadialAxis constructor @@ -96371,16 +96473,16 @@ def scene(self): """ The 'scene' property is an instance of Scene that may be specified as: - - An instance of plotly.graph_objs.layout.Scene + - An instance of :class:`plotly.graph_objs.layout.Scene` - A dict of string/value properties that will be passed to the Scene constructor Supported dict properties: annotations - A tuple of - plotly.graph_objects.layout.scene.Annotation - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.Annotation` instances or dicts with + compatible properties annotationdefaults When used in a template (as layout.template.lay out.scene.annotationdefaults), sets the default @@ -96404,11 +96506,11 @@ def scene(self): bgcolor camera - plotly.graph_objects.layout.scene.Camera - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Camer + a` instance or dict with compatible properties domain - plotly.graph_objects.layout.scene.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Domai + n` instance or dict with compatible properties dragmode Determines the mode of drag interactions for this scene. @@ -96420,14 +96522,14 @@ def scene(self): camera attributes. Defaults to `layout.uirevision`. xaxis - plotly.graph_objects.layout.scene.XAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.XAxis + ` instance or dict with compatible properties yaxis - plotly.graph_objects.layout.scene.YAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.YAxis + ` instance or dict with compatible properties zaxis - plotly.graph_objects.layout.scene.ZAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.ZAxis + ` instance or dict with compatible properties Returns ------- @@ -96526,8 +96628,8 @@ def shapes(self): Specifies whether shapes are drawn below or above traces. line - plotly.graph_objects.layout.shape.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any @@ -96688,7 +96790,7 @@ def shapedefaults(self): The 'shapedefaults' property is an instance of Shape that may be specified as: - - An instance of plotly.graph_objs.layout.Shape + - An instance of :class:`plotly.graph_objs.layout.Shape` - A dict of string/value properties that will be passed to the Shape constructor @@ -96756,8 +96858,9 @@ def sliders(self): Sets the width (in px) of the border enclosing the slider. currentvalue - plotly.graph_objects.layout.slider.Currentvalue - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Curr + entvalue` instance or dict with compatible + properties font Sets the font of the slider step labels. len @@ -96786,9 +96889,9 @@ def sliders(self): Set the padding of the slider component along each side. steps - A tuple of - plotly.graph_objects.layout.slider.Step - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + slider.Step` instances or dicts with compatible + properties stepdefaults When used in a template (as layout.template.layout.slider.stepdefaults), @@ -96813,8 +96916,9 @@ def sliders(self): tickwidth Sets the tick width (in px). transition - plotly.graph_objects.layout.slider.Transition - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Tran + sition` instance or dict with compatible + properties visible Determines whether or not the slider is visible. @@ -96855,7 +96959,7 @@ def sliderdefaults(self): The 'sliderdefaults' property is an instance of Slider that may be specified as: - - An instance of plotly.graph_objs.layout.Slider + - An instance of :class:`plotly.graph_objs.layout.Slider` - A dict of string/value properties that will be passed to the Slider constructor @@ -96947,18 +97051,18 @@ def template(self): The 'template' property is an instance of Template that may be specified as: - - An instance of plotly.graph_objs.layout.Template + - An instance of :class:`plotly.graph_objs.layout.Template` - A dict of string/value properties that will be passed to the Template constructor Supported dict properties: data - plotly.graph_objects.layout.template.Data - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.template.Da + ta` instance or dict with compatible properties layout - plotly.graph_objects.Layout instance or dict - with compatible properties + :class:`plotly.graph_objects.Layout` instance + or dict with compatible properties - The name of a registered template where current registered templates are stored in the plotly.io.templates configuration object. The names @@ -96989,26 +97093,27 @@ def ternary(self): """ The 'ternary' property is an instance of Ternary that may be specified as: - - An instance of plotly.graph_objs.layout.Ternary + - An instance of :class:`plotly.graph_objs.layout.Ternary` - A dict of string/value properties that will be passed to the Ternary constructor Supported dict properties: aaxis - plotly.graph_objects.layout.ternary.Aaxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Aax + is` instance or dict with compatible properties baxis - plotly.graph_objects.layout.ternary.Baxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Bax + is` instance or dict with compatible properties bgcolor Set the background color of the subplot caxis - plotly.graph_objects.layout.ternary.Caxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Cax + is` instance or dict with compatible properties domain - plotly.graph_objects.layout.ternary.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Dom + ain` instance or dict with compatible + properties sum The number each triplet should sum to, and the maximum range of each axis @@ -97035,7 +97140,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.Title + - An instance of :class:`plotly.graph_objs.layout.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -97115,7 +97220,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.title.Font + - An instance of :class:`plotly.graph_objs.layout.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -97160,7 +97265,7 @@ def transition(self): The 'transition' property is an instance of Transition that may be specified as: - - An instance of plotly.graph_objs.layout.Transition + - An instance of :class:`plotly.graph_objs.layout.Transition` - A dict of string/value properties that will be passed to the Transition constructor @@ -97252,7 +97357,7 @@ def uniformtext(self): """ The 'uniformtext' property is an instance of Uniformtext that may be specified as: - - An instance of plotly.graph_objs.layout.Uniformtext + - An instance of :class:`plotly.graph_objs.layout.Uniformtext` - A dict of string/value properties that will be passed to the Uniformtext constructor @@ -97309,9 +97414,9 @@ def updatemenus(self): Sets the width (in px) of the border enclosing the update menu. buttons - A tuple of - plotly.graph_objects.layout.updatemenu.Button - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + updatemenu.Button` instances or dicts with + compatible properties buttondefaults When used in a template (as layout.template.lay out.updatemenu.buttondefaults), sets the @@ -97397,7 +97502,7 @@ def updatemenudefaults(self): The 'updatemenudefaults' property is an instance of Updatemenu that may be specified as: - - An instance of plotly.graph_objs.layout.Updatemenu + - An instance of :class:`plotly.graph_objs.layout.Updatemenu` - A dict of string/value properties that will be passed to the Updatemenu constructor @@ -97577,7 +97682,7 @@ def xaxis(self): """ The 'xaxis' property is an instance of XAxis that may be specified as: - - An instance of plotly.graph_objs.layout.XAxis + - An instance of :class:`plotly.graph_objs.layout.XAxis` - A dict of string/value properties that will be passed to the XAxis constructor @@ -97785,11 +97890,13 @@ def xaxis(self): negative, regardless of the input data. Applies only to linear axes. rangeselector - plotly.graph_objects.layout.xaxis.Rangeselector - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Range + selector` instance or dict with compatible + properties rangeslider - plotly.graph_objects.layout.xaxis.Rangeslider - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Range + slider` instance or dict with compatible + properties scaleanchor If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the @@ -97916,9 +98023,9 @@ def xaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.xaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout. + xaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.xaxis.tickformatstopdefaults), sets the @@ -97971,8 +98078,8 @@ def xaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.xaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.xaxis.title.font instead. Sets this axis' title font. Note that @@ -98019,7 +98126,7 @@ def yaxis(self): """ The 'yaxis' property is an instance of YAxis that may be specified as: - - An instance of plotly.graph_objs.layout.YAxis + - An instance of :class:`plotly.graph_objs.layout.YAxis` - A dict of string/value properties that will be passed to the YAxis constructor @@ -98352,9 +98459,9 @@ def yaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.yaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout. + yaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.yaxis.tickformatstopdefaults), sets the @@ -98407,8 +98514,8 @@ def yaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.yaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.yaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.yaxis.title.font instead. Sets this axis' title font. Note that @@ -98460,10 +98567,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ angularaxis - plotly.graph_objects.layout.AngularAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.AngularAxis` + instance or dict with compatible properties annotations - A tuple of plotly.graph_objects.layout.Annotation + A tuple of + :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -98534,11 +98642,11 @@ def _prop_descriptions(self): well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis - plotly.graph_objects.layout.Coloraxis instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Coloraxis` instance + or dict with compatible properties colorscale - plotly.graph_objects.layout.Colorscale instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties colorway Sets the default trace colors. datarevision @@ -98623,11 +98731,11 @@ def _prop_descriptions(self): over one another, you might need to an "opacity" to see multiple bars. geo - plotly.graph_objects.layout.Geo instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Geo` instance or + dict with compatible properties grid - plotly.graph_objects.layout.Grid instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Grid` instance or + dict with compatible properties height Sets the plot's height (in px). hiddenlabels @@ -98654,8 +98762,8 @@ def _prop_descriptions(self): these objects will not supersede hover on point-like objects in case of conflict. hoverlabel - plotly.graph_objects.layout.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` @@ -98665,21 +98773,21 @@ def _prop_descriptions(self): cartesian coordinates. For anything else the default value is "closest". images - A tuple of plotly.graph_objects.layout.Image instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.Image` + instances or dicts with compatible properties imagedefaults When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images legend - plotly.graph_objects.layout.Legend instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Legend` instance or + dict with compatible properties mapbox - plotly.graph_objects.layout.Mapbox instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Mapbox` instance or + dict with compatible properties margin - plotly.graph_objects.layout.Margin instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Margin` instance or + dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such as the @@ -98694,8 +98802,8 @@ def _prop_descriptions(self): metasrc Sets the source reference on plot.ly for meta . modebar - plotly.graph_objects.layout.Modebar instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Modebar` instance + or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given @@ -98712,14 +98820,14 @@ def _prop_descriptions(self): Sets the background color of the plotting area in- between x and y axes. polar - plotly.graph_objects.layout.Polar instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Polar` instance or + dict with compatible properties radialaxis - plotly.graph_objects.layout.RadialAxis instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.RadialAxis` + instance or dict with compatible properties scene - plotly.graph_objects.layout.Scene instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Scene` instance or + dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or @@ -98735,8 +98843,8 @@ def _prop_descriptions(self): thousands. In English locales, dflt is ".," but other locales may alter this default. shapes - A tuple of plotly.graph_objects.layout.Shape instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.Shape` + instances or dicts with compatible properties shapedefaults When used in a template (as layout.template.layout.shapedefaults), sets the default @@ -98748,8 +98856,8 @@ def _prop_descriptions(self): legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders - A tuple of plotly.graph_objects.layout.Slider instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.Slider` + instances or dicts with compatible properties sliderdefaults When used in a template (as layout.template.layout.sliderdefaults), sets the @@ -98791,11 +98899,11 @@ def _prop_descriptions(self): an item with matching `templateitemname` and `visible: false`. ternary - plotly.graph_objects.layout.Ternary instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Ternary` instance + or dict with compatible properties title - plotly.graph_objects.layout.Title instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Title` instance or + dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the title's font used to be @@ -98828,10 +98936,11 @@ def _prop_descriptions(self): and the y axis range will reset but the x axis range will retain any user-driven zoom. uniformtext - plotly.graph_objects.layout.Uniformtext instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Uniformtext` + instance or dict with compatible properties updatemenus - A tuple of plotly.graph_objects.layout.Updatemenu + A tuple of + :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as @@ -98870,11 +98979,11 @@ def _prop_descriptions(self): width Sets the plot's width (in px). xaxis - plotly.graph_objects.layout.XAxis instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.XAxis` instance or + dict with compatible properties yaxis - plotly.graph_objects.layout.YAxis instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.YAxis` instance or + dict with compatible properties """ _mapped_properties = {"titlefont": ("title", "font")} @@ -98973,12 +99082,13 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Layout + an instance of :class:`plotly.graph_objs.Layout` angularaxis - plotly.graph_objects.layout.AngularAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.AngularAxis` + instance or dict with compatible properties annotations - A tuple of plotly.graph_objects.layout.Annotation + A tuple of + :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -99049,11 +99159,11 @@ def __init__( well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis - plotly.graph_objects.layout.Coloraxis instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Coloraxis` instance + or dict with compatible properties colorscale - plotly.graph_objects.layout.Colorscale instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties colorway Sets the default trace colors. datarevision @@ -99138,11 +99248,11 @@ def __init__( over one another, you might need to an "opacity" to see multiple bars. geo - plotly.graph_objects.layout.Geo instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Geo` instance or + dict with compatible properties grid - plotly.graph_objects.layout.Grid instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Grid` instance or + dict with compatible properties height Sets the plot's height (in px). hiddenlabels @@ -99169,8 +99279,8 @@ def __init__( these objects will not supersede hover on point-like objects in case of conflict. hoverlabel - plotly.graph_objects.layout.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` @@ -99180,21 +99290,21 @@ def __init__( cartesian coordinates. For anything else the default value is "closest". images - A tuple of plotly.graph_objects.layout.Image instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.Image` + instances or dicts with compatible properties imagedefaults When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images legend - plotly.graph_objects.layout.Legend instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Legend` instance or + dict with compatible properties mapbox - plotly.graph_objects.layout.Mapbox instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Mapbox` instance or + dict with compatible properties margin - plotly.graph_objects.layout.Margin instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Margin` instance or + dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such as the @@ -99209,8 +99319,8 @@ def __init__( metasrc Sets the source reference on plot.ly for meta . modebar - plotly.graph_objects.layout.Modebar instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Modebar` instance + or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given @@ -99227,14 +99337,14 @@ def __init__( Sets the background color of the plotting area in- between x and y axes. polar - plotly.graph_objects.layout.Polar instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Polar` instance or + dict with compatible properties radialaxis - plotly.graph_objects.layout.RadialAxis instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.RadialAxis` + instance or dict with compatible properties scene - plotly.graph_objects.layout.Scene instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Scene` instance or + dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or @@ -99250,8 +99360,8 @@ def __init__( thousands. In English locales, dflt is ".," but other locales may alter this default. shapes - A tuple of plotly.graph_objects.layout.Shape instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.Shape` + instances or dicts with compatible properties shapedefaults When used in a template (as layout.template.layout.shapedefaults), sets the default @@ -99263,8 +99373,8 @@ def __init__( legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders - A tuple of plotly.graph_objects.layout.Slider instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.Slider` + instances or dicts with compatible properties sliderdefaults When used in a template (as layout.template.layout.sliderdefaults), sets the @@ -99306,11 +99416,11 @@ def __init__( an item with matching `templateitemname` and `visible: false`. ternary - plotly.graph_objects.layout.Ternary instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.Ternary` instance + or dict with compatible properties title - plotly.graph_objects.layout.Title instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.Title` instance or + dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the title's font used to be @@ -99343,10 +99453,11 @@ def __init__( and the y axis range will reset but the x axis range will retain any user-driven zoom. uniformtext - plotly.graph_objects.layout.Uniformtext instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Uniformtext` + instance or dict with compatible properties updatemenus - A tuple of plotly.graph_objects.layout.Updatemenu + A tuple of + :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as @@ -99385,11 +99496,11 @@ def __init__( width Sets the plot's width (in px). xaxis - plotly.graph_objects.layout.XAxis instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.XAxis` instance or + dict with compatible properties yaxis - plotly.graph_objects.layout.YAxis instance or dict with - compatible properties + :class:`plotly.graph_objects.layout.YAxis` instance or + dict with compatible properties Returns ------- @@ -99410,7 +99521,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Layout constructor must be a dict or -an instance of plotly.graph_objs.Layout""" +an instance of :class:`plotly.graph_objs.Layout`""" ) # Handle skip_invalid @@ -99889,7 +100000,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Frame + an instance of :class:`plotly.graph_objs.Frame` baseframe The name of the frame into which this frame's properties are merged before applying. This is used to @@ -99930,7 +100041,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.Frame constructor must be a dict or -an instance of plotly.graph_objs.Frame""" +an instance of :class:`plotly.graph_objs.Frame`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/_figure.py b/packages/python/plotly/plotly/graph_objs/_figure.py index b88f48823af..facc2a8abd2 100644 --- a/packages/python/plotly/plotly/graph_objs/_figure.py +++ b/packages/python/plotly/plotly/graph_objs/_figure.py @@ -56,7 +56,7 @@ def __init__( self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs ): """ - Create a new Figure instance + Create a new :class:Figure instance Parameters ---------- @@ -93,18 +93,18 @@ def __init__( layout The 'layout' property is an instance of Layout that may be specified as: - - An instance of plotly.graph_objs.Layout + - An instance of :class:`plotly.graph_objs.Layout` - A dict of string/value properties that will be passed to the Layout constructor Supported dict properties: angularaxis - plotly.graph_objects.layout.AngularAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.AngularAxis + ` instance or dict with compatible properties annotations A tuple of - plotly.graph_objects.layout.Annotation + :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -183,11 +183,11 @@ def __init__( missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis - plotly.graph_objects.layout.Coloraxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Coloraxis` + instance or dict with compatible properties colorscale - plotly.graph_objects.layout.Colorscale instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties colorway Sets the default trace colors. datarevision @@ -285,11 +285,11 @@ def __init__( over one another, you might need to an "opacity" to see multiple bars. geo - plotly.graph_objects.layout.Geo instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Geo` + instance or dict with compatible properties grid - plotly.graph_objects.layout.Grid instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Grid` + instance or dict with compatible properties height Sets the plot's height (in px). hiddenlabels @@ -318,8 +318,8 @@ def __init__( objects will not supersede hover on point-like objects in case of conflict. hoverlabel - plotly.graph_objects.layout.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, @@ -330,7 +330,8 @@ def __init__( cartesian coordinates. For anything else the default value is "closest". images - A tuple of plotly.graph_objects.layout.Image + A tuple of + :class:`plotly.graph_objects.layout.Image` instances or dicts with compatible properties imagedefaults When used in a template (as @@ -338,14 +339,14 @@ def __init__( default property values to use for elements of layout.images legend - plotly.graph_objects.layout.Legend instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Legend` + instance or dict with compatible properties mapbox - plotly.graph_objects.layout.Mapbox instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Mapbox` + instance or dict with compatible properties margin - plotly.graph_objects.layout.Margin instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Margin` + instance or dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such @@ -362,8 +363,8 @@ def __init__( Sets the source reference on plot.ly for meta . modebar - plotly.graph_objects.layout.Modebar instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Modebar` + instance or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire @@ -382,14 +383,14 @@ def __init__( Sets the background color of the plotting area in-between x and y axes. polar - plotly.graph_objects.layout.Polar instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Polar` + instance or dict with compatible properties radialaxis - plotly.graph_objects.layout.RadialAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.RadialAxis` + instance or dict with compatible properties scene - plotly.graph_objects.layout.Scene instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Scene` + instance or dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, @@ -406,7 +407,8 @@ def __init__( dflt is ".," but other locales may alter this default. shapes - A tuple of plotly.graph_objects.layout.Shape + A tuple of + :class:`plotly.graph_objects.layout.Shape` instances or dicts with compatible properties shapedefaults When used in a template (as @@ -421,7 +423,8 @@ def __init__( trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders - A tuple of plotly.graph_objects.layout.Slider + A tuple of + :class:`plotly.graph_objects.layout.Slider` instances or dicts with compatible properties sliderdefaults When used in a template (as @@ -470,11 +473,11 @@ def __init__( plot, make an item with matching `templateitemname` and `visible: false`. ternary - plotly.graph_objects.layout.Ternary instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Ternary` + instance or dict with compatible properties title - plotly.graph_objects.layout.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the @@ -513,11 +516,11 @@ def __init__( range will reset but the x axis range will retain any user-driven zoom. uniformtext - plotly.graph_objects.layout.Uniformtext - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.Uniformtext + ` instance or dict with compatible properties updatemenus A tuple of - plotly.graph_objects.layout.Updatemenu + :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as @@ -558,11 +561,11 @@ def __init__( width Sets the plot's width (in px). xaxis - plotly.graph_objects.layout.XAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.XAxis` + instance or dict with compatible properties yaxis - plotly.graph_objects.layout.YAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.YAxis` + instance or dict with compatible properties frames The 'frames' property is a tuple of instances of @@ -658,8 +661,8 @@ def add_area( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.area.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.area.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -671,8 +674,8 @@ def add_area( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.area.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -703,8 +706,8 @@ def add_area( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.area.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Stream` instance or + dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for @@ -892,11 +895,11 @@ def add_bar( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.bar.ErrorX instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties error_y - plotly.graph_objects.bar.ErrorY instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -905,8 +908,8 @@ def add_bar( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.bar.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -959,8 +962,8 @@ def add_bar( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.bar.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -1005,8 +1008,8 @@ def add_bar( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.bar.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -1018,8 +1021,8 @@ def add_bar( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.bar.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -1099,8 +1102,8 @@ def add_bar( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.bar.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -1317,8 +1320,8 @@ def add_barpolar( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.barpolar.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -1360,8 +1363,8 @@ def add_barpolar( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.barpolar.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -1396,8 +1399,8 @@ def add_barpolar( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.barpolar.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -1409,8 +1412,8 @@ def add_barpolar( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.barpolar.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -1457,8 +1460,8 @@ def add_barpolar( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.barpolar.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -1683,8 +1686,8 @@ def add_box( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.box.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? @@ -1734,8 +1737,8 @@ def add_box( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.box.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute @@ -1746,8 +1749,8 @@ def add_box( lowerfencesrc Sets the source reference on plot.ly for lowerfence . marker - plotly.graph_objects.box.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect @@ -1856,8 +1859,8 @@ def add_box( sdsrc Sets the source reference on plot.ly for sd . selected - plotly.graph_objects.box.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -1869,8 +1872,8 @@ def add_box( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.box.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -1903,8 +1906,8 @@ def add_box( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.box.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute @@ -2130,8 +2133,8 @@ def add_candlestick( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.candlestick.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties high Sets the high values. highsrc @@ -2144,8 +2147,8 @@ def add_candlestick( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.candlestick.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -2157,15 +2160,15 @@ def add_candlestick( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.candlestick.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.candlestick.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties low Sets the low values. lowsrc @@ -2205,8 +2208,8 @@ def add_candlestick( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.candlestick.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -2387,8 +2390,8 @@ def add_carpet( coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis - plotly.graph_objects.carpet.Aaxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties asrc Sets the source reference on plot.ly for a . b @@ -2399,8 +2402,8 @@ def add_carpet( coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis - plotly.graph_objects.carpet.Baxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet @@ -2457,8 +2460,8 @@ def add_carpet( opacity Sets the opacity of the trace. stream - plotly.graph_objects.carpet.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -2641,8 +2644,8 @@ def add_choropleth( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choropleth.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -2688,8 +2691,8 @@ def add_choropleth( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choropleth.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -2743,8 +2746,8 @@ def add_choropleth( locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choropleth.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -2768,8 +2771,8 @@ def add_choropleth( will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choropleth.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -2784,8 +2787,8 @@ def add_choropleth( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choropleth.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties text Sets the text elements associated with each location. textsrc @@ -2813,8 +2816,8 @@ def add_choropleth( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choropleth.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -2984,8 +2987,8 @@ def add_choroplethmapbox( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choroplethmapbox.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -3023,8 +3026,8 @@ def add_choroplethmapbox( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choroplethmapbox.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -3072,8 +3075,8 @@ def add_choroplethmapbox( locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choroplethmapbox.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -3097,8 +3100,8 @@ def add_choroplethmapbox( will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choroplethmapbox.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -3113,8 +3116,8 @@ def add_choroplethmapbox( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choroplethmapbox.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -3147,8 +3150,8 @@ def add_choroplethmapbox( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choroplethmapbox.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -3342,8 +3345,8 @@ def add_cone( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.cone.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -3371,8 +3374,8 @@ def add_cone( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.cone.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -3415,11 +3418,11 @@ def add_cone( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.cone.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objects.cone.Lightposition instance or + :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -3480,8 +3483,8 @@ def add_cone( the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. stream - plotly.graph_objects.cone.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and @@ -3710,8 +3713,8 @@ def add_contour( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contour.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -3730,8 +3733,8 @@ def add_contour( to true if `z` is a one dimensional array otherwise it is defaulted to false. contours - plotly.graph_objects.contour.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -3756,8 +3759,8 @@ def add_contour( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.contour.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -3803,8 +3806,8 @@ def add_contour( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contour.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -3842,8 +3845,8 @@ def add_contour( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contour.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -4148,8 +4151,8 @@ def add_contourcarpet( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contourcarpet.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -4163,8 +4166,8 @@ def add_contourcarpet( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.contourcarpet.Contours instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -4196,8 +4199,8 @@ def add_contourcarpet( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contourcarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -4235,8 +4238,8 @@ def add_contourcarpet( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contourcarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -4458,8 +4461,8 @@ def add_densitymapbox( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.densitymapbox.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -4487,8 +4490,8 @@ def add_densitymapbox( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.densitymapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -4579,8 +4582,8 @@ def add_densitymapbox( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.densitymapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -4791,8 +4794,8 @@ def add_funnel( and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.funnel.Connector instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -4815,8 +4818,8 @@ def add_funnel( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnel.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -4870,8 +4873,8 @@ def add_funnel( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnel.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -4922,8 +4925,8 @@ def add_funnel( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnel.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -5189,8 +5192,8 @@ def add_funnelarea( dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.funnelarea.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -5199,8 +5202,8 @@ def add_funnelarea( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnelarea.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -5262,8 +5265,8 @@ def add_funnelarea( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnelarea.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -5293,8 +5296,8 @@ def add_funnelarea( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnelarea.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -5333,8 +5336,8 @@ def add_funnelarea( Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.funnelarea.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -5528,8 +5531,8 @@ def add_heatmap( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmap.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -5566,8 +5569,8 @@ def add_heatmap( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -5643,8 +5646,8 @@ def add_heatmap( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -5908,8 +5911,8 @@ def add_heatmapgl( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmapgl.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -5941,8 +5944,8 @@ def add_heatmapgl( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmapgl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -5977,8 +5980,8 @@ def add_heatmapgl( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmapgl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmapgl.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -6237,8 +6240,8 @@ def add_histogram( can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup` cumulative - plotly.graph_objects.histogram.Cumulative instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -6247,11 +6250,11 @@ def add_histogram( customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.histogram.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.histogram.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by @@ -6285,8 +6288,8 @@ def add_histogram( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -6329,8 +6332,8 @@ def add_histogram( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -6372,8 +6375,8 @@ def add_histogram( value of the each bar spans along the vertical (horizontal). selected - plotly.graph_objects.histogram.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -6385,8 +6388,8 @@ def add_histogram( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.histogram.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. @@ -6417,8 +6420,8 @@ def add_histogram( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.histogram.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -6432,8 +6435,8 @@ def add_histogram( x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins - plotly.graph_objects.histogram.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -6446,8 +6449,8 @@ def add_histogram( y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins - plotly.graph_objects.histogram.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -6636,8 +6639,8 @@ def add_histogram2d( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2d.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -6690,8 +6693,8 @@ def add_histogram2d( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -6730,8 +6733,8 @@ def add_histogram2d( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram2d.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -6775,8 +6778,8 @@ def add_histogram2d( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2d.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -6819,8 +6822,8 @@ def add_histogram2d( Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2d.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xgap @@ -6842,8 +6845,8 @@ def add_histogram2d( Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2d.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ygap @@ -7074,8 +7077,8 @@ def add_histogram2dcontour( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2dcontour.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -7089,8 +7092,8 @@ def add_histogram2dcontour( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.histogram2dcontour.Contours - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -7131,8 +7134,8 @@ def add_histogram2dcontour( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2dcontour.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -7171,11 +7174,11 @@ def add_histogram2dcontour( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.histogram2dcontour.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties marker - plotly.graph_objects.histogram2dcontour.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -7225,8 +7228,8 @@ def add_histogram2dcontour( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2dcontour.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -7269,8 +7272,8 @@ def add_histogram2dcontour( Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2dcontour.XBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -7290,8 +7293,8 @@ def add_histogram2dcontour( Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2dcontour.YBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -7480,8 +7483,8 @@ def add_image( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.image.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -7540,8 +7543,8 @@ def add_image( opacity Sets the opacity of the trace. stream - plotly.graph_objects.image.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -7717,11 +7720,11 @@ def add_indicator( customdatasrc Sets the source reference on plot.ly for customdata . delta - plotly.graph_objects.indicator.Delta instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties domain - plotly.graph_objects.indicator.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties gauge The gauge of the Indicator plot. ids @@ -7755,14 +7758,14 @@ def add_indicator( Sets the trace name. The trace name appear as the legend item and on hover. number - plotly.graph_objects.indicator.Number instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties stream - plotly.graph_objects.indicator.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties title - plotly.graph_objects.indicator.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -7907,8 +7910,8 @@ def add_isosurface( chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.isosurface.Caps instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -7935,8 +7938,8 @@ def add_isosurface( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.isosurface.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -7950,8 +7953,8 @@ def add_isosurface( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.isosurface.Contour instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -7971,8 +7974,8 @@ def add_isosurface( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.isosurface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -8018,11 +8021,11 @@ def add_isosurface( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.isosurface.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.isosurface.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -8066,17 +8069,17 @@ def add_isosurface( Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.isosurface.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties spaceframe - plotly.graph_objects.isosurface.Spaceframe instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.isosurface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties surface - plotly.graph_objects.isosurface.Surface instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -8330,8 +8333,8 @@ def add_mesh3d( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.mesh3d.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -8345,8 +8348,8 @@ def add_mesh3d( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.mesh3d.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -8377,8 +8380,8 @@ def add_mesh3d( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.mesh3d.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -8461,11 +8464,11 @@ def add_mesh3d( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.mesh3d.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.mesh3d.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -8509,8 +8512,8 @@ def add_mesh3d( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.mesh3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -8730,8 +8733,8 @@ def add_ohlc( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.ohlc.Decreasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties high Sets the high values. highsrc @@ -8744,8 +8747,8 @@ def add_ohlc( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.ohlc.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -8757,15 +8760,15 @@ def add_ohlc( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.ohlc.Increasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.ohlc.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties low Sets the low values. lowsrc @@ -8805,8 +8808,8 @@ def add_ohlc( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.ohlc.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -8988,8 +8991,8 @@ def add_parcats( the default property values to use for elements of parcats.dimensions domain - plotly.graph_objects.parcats.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -9030,8 +9033,8 @@ def add_parcats( labelfont Sets the font for the `dimension` labels. line - plotly.graph_objects.parcats.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9056,8 +9059,8 @@ def add_parcats( If `backward`, sort paths based on dimensions categories from right to left. stream - plotly.graph_objects.parcats.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties tickfont Sets the font for the `category` labels. uid @@ -9177,8 +9180,8 @@ def add_parcoords( the default property values to use for elements of parcoords.dimensions domain - plotly.graph_objects.parcoords.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -9200,8 +9203,8 @@ def add_parcoords( may be positioned better inside margins when `labelposition` is set to "bottom". line - plotly.graph_objects.parcoords.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9223,8 +9226,8 @@ def add_parcoords( rangefont Sets the font for the `dimension` range values. stream - plotly.graph_objects.parcoords.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid @@ -9374,8 +9377,8 @@ def add_pie( dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.pie.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. @@ -9387,8 +9390,8 @@ def add_pie( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pie.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -9461,8 +9464,8 @@ def add_pie( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pie.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9508,8 +9511,8 @@ def add_pie( Determines whether or not the sectors are reordered from largest to smallest. stream - plotly.graph_objects.pie.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -9548,8 +9551,8 @@ def add_pie( Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.pie.Title instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used @@ -9724,8 +9727,8 @@ def add_pointcloud( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pointcloud.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -9748,8 +9751,8 @@ def add_pointcloud( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pointcloud.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9774,8 +9777,8 @@ def add_pointcloud( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.pointcloud.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -9968,8 +9971,8 @@ def add_sankey( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sankey.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -9978,8 +9981,8 @@ def add_sankey( superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel - plotly.graph_objects.sankey.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -10018,8 +10021,8 @@ def add_sankey( any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. stream - plotly.graph_objects.sankey.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties textfont Sets the font for node labels uid @@ -10199,11 +10202,11 @@ def add_scatter( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scatter.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -10250,8 +10253,8 @@ def add_scatter( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -10304,11 +10307,11 @@ def add_scatter( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties marker - plotly.graph_objects.scatter.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -10350,8 +10353,8 @@ def add_scatter( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatter.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -10387,8 +10390,8 @@ def add_scatter( fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. stream - plotly.graph_objects.scatter.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -10455,8 +10458,8 @@ def add_scatter( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatter.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -10658,14 +10661,14 @@ def add_scatter3d( customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.scatter3d.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter3d.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties error_z - plotly.graph_objects.scatter3d.ErrorZ instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -10674,8 +10677,8 @@ def add_scatter3d( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter3d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -10722,11 +10725,11 @@ def add_scatter3d( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter3d.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scatter3d.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -10755,8 +10758,8 @@ def add_scatter3d( opacity Sets the opacity of the trace. projection - plotly.graph_objects.scatter3d.Projection instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), @@ -10767,8 +10770,8 @@ def add_scatter3d( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatter3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a @@ -10784,8 +10787,8 @@ def add_scatter3d( flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont - plotly.graph_objects.scatter3d.Textfont instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Textfont` + instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. @@ -11029,8 +11032,8 @@ def add_scattercarpet( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattercarpet.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -11082,11 +11085,11 @@ def add_scattercarpet( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattercarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scattercarpet.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11115,8 +11118,8 @@ def add_scattercarpet( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattercarpet.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -11128,8 +11131,8 @@ def add_scattercarpet( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattercarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the @@ -11191,8 +11194,8 @@ def add_scattercarpet( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattercarpet.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -11390,8 +11393,8 @@ def add_scattergeo( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergeo.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -11442,8 +11445,8 @@ def add_scattergeo( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergeo.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", @@ -11462,8 +11465,8 @@ def add_scattergeo( lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattergeo.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11492,8 +11495,8 @@ def add_scattergeo( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergeo.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -11505,8 +11508,8 @@ def add_scattergeo( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergeo.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same @@ -11569,8 +11572,8 @@ def add_scattergeo( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergeo.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -11724,11 +11727,11 @@ def add_scattergl( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scattergl.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scattergl.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -11764,8 +11767,8 @@ def add_scattergl( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -11812,11 +11815,11 @@ def add_scattergl( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergl.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scattergl.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11840,8 +11843,8 @@ def add_scattergl( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergl.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -11853,8 +11856,8 @@ def add_scattergl( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -11915,8 +11918,8 @@ def add_scattergl( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergl.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -12121,8 +12124,8 @@ def add_scattermapbox( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattermapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -12173,15 +12176,15 @@ def add_scattermapbox( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattermapbox.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattermapbox.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -12208,8 +12211,8 @@ def add_scattermapbox( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattermapbox.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -12221,8 +12224,8 @@ def add_scattermapbox( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattermapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -12288,8 +12291,8 @@ def add_scattermapbox( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattermapbox.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -12468,8 +12471,8 @@ def add_scatterpolar( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolar.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -12522,11 +12525,11 @@ def add_scatterpolar( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolar.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolar.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -12563,8 +12566,8 @@ def add_scatterpolar( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolar.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -12576,8 +12579,8 @@ def add_scatterpolar( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolar.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -12655,8 +12658,8 @@ def add_scatterpolar( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolar.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -12845,8 +12848,8 @@ def add_scatterpolargl( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolargl.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -12893,11 +12896,11 @@ def add_scatterpolargl( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolargl.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolargl.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -12934,8 +12937,8 @@ def add_scatterpolargl( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolargl.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -12947,8 +12950,8 @@ def add_scatterpolargl( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolargl.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -13026,8 +13029,8 @@ def add_scatterpolargl( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolargl.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -13223,8 +13226,8 @@ def add_scatterternary( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterternary.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -13277,11 +13280,11 @@ def add_scatterternary( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterternary.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterternary.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -13310,8 +13313,8 @@ def add_scatterternary( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scatterternary.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -13323,8 +13326,8 @@ def add_scatterternary( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterternary.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default @@ -13398,8 +13401,8 @@ def add_scatterternary( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterternary.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -13531,11 +13534,12 @@ def add_splom( customdatasrc Sets the source reference on plot.ly for customdata . diagonal - plotly.graph_objects.splom.Diagonal instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties dimensions - A tuple of plotly.graph_objects.splom.Dimension - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties dimensiondefaults When used in a template (as layout.template.data.splom.dimensiondefaults), sets the @@ -13549,8 +13553,8 @@ def add_splom( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.splom.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -13592,8 +13596,8 @@ def add_splom( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.splom.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -13615,8 +13619,8 @@ def add_splom( opacity Sets the opacity of the trace. selected - plotly.graph_objects.splom.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -13634,8 +13638,8 @@ def add_splom( Determines whether or not subplots on the upper half from the diagonal are displayed. stream - plotly.graph_objects.splom.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string @@ -13667,8 +13671,8 @@ def add_splom( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.splom.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -13845,8 +13849,8 @@ def add_streamtube( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.streamtube.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -13874,8 +13878,8 @@ def add_streamtube( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.streamtube.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -13917,11 +13921,11 @@ def add_streamtube( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.streamtube.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.streamtube.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties maxdisplayed The maximum number of displayed segments in a streamtube. @@ -13972,11 +13976,11 @@ def add_streamtube( 1, which avoids two max divergence tubes from touching at adjacent starting positions. starts - plotly.graph_objects.streamtube.Starts instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties stream - plotly.graph_objects.streamtube.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text @@ -14175,8 +14179,8 @@ def add_sunburst( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sunburst.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -14185,8 +14189,8 @@ def add_sunburst( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.sunburst.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -14247,8 +14251,8 @@ def add_sunburst( labelssrc Sets the source reference on plot.ly for labels . leaf - plotly.graph_objects.sunburst.Leaf instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root @@ -14256,8 +14260,8 @@ def add_sunburst( filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.sunburst.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -14299,8 +14303,8 @@ def add_sunburst( parentssrc Sets the source reference on plot.ly for parents . stream - plotly.graph_objects.sunburst.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -14530,8 +14534,8 @@ def add_surface( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.surface.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -14548,8 +14552,8 @@ def add_surface( Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours - plotly.graph_objects.surface.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -14570,8 +14574,8 @@ def add_surface( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.surface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -14613,11 +14617,11 @@ def add_surface( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.surface.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.surface.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -14661,8 +14665,8 @@ def add_surface( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.surface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. @@ -14828,8 +14832,8 @@ def add_table( Parameters ---------- cells - plotly.graph_objects.table.Cells instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column @@ -14851,11 +14855,11 @@ def add_table( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.table.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties header - plotly.graph_objects.table.Header instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -14864,8 +14868,8 @@ def add_table( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.table.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -14891,8 +14895,8 @@ def add_table( Sets the trace name. The trace name appear as the legend item and on hover. stream - plotly.graph_objects.table.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -15036,8 +15040,8 @@ def add_treemap( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.treemap.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -15046,8 +15050,8 @@ def add_treemap( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.treemap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -15104,8 +15108,8 @@ def add_treemap( filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.treemap.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -15147,11 +15151,11 @@ def add_treemap( parentssrc Sets the source reference on plot.ly for parents . pathbar - plotly.graph_objects.treemap.Pathbar instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties stream - plotly.graph_objects.treemap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -15188,8 +15192,8 @@ def add_treemap( Sets the source reference on plot.ly for texttemplate . tiling - plotly.graph_objects.treemap.Tiling instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -15365,8 +15369,8 @@ def add_violin( estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box - plotly.graph_objects.violin.Box instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -15386,8 +15390,8 @@ def add_violin( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.violin.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density estimate or any @@ -15438,14 +15442,14 @@ def add_violin( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.violin.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties marker - plotly.graph_objects.violin.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties meanline - plotly.graph_objects.violin.Meanline instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -15510,8 +15514,8 @@ def add_violin( width*count* means the violins are scaled by the number of sample points makingup each violin. selected - plotly.graph_objects.violin.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -15542,8 +15546,8 @@ def add_violin( settings, use mode "manual" and fill in the `span` attribute. stream - plotly.graph_objects.violin.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -15576,8 +15580,8 @@ def add_violin( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.violin.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -15776,8 +15780,8 @@ def add_volume( chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.volume.Caps instance or dict with - compatible properties + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -15804,8 +15808,8 @@ def add_volume( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.volume.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -15819,8 +15823,8 @@ def add_volume( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.volume.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -15840,8 +15844,8 @@ def add_volume( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.volume.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -15887,11 +15891,11 @@ def add_volume( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.volume.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.volume.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -15946,17 +15950,17 @@ def add_volume( Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.volume.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties spaceframe - plotly.graph_objects.volume.Spaceframe instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.volume.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties surface - plotly.graph_objects.volume.Surface instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -16171,8 +16175,8 @@ def add_waterfall( and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.waterfall.Connector instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -16184,8 +16188,8 @@ def add_waterfall( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.waterfall.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. dy @@ -16198,8 +16202,8 @@ def add_waterfall( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.waterfall.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -16243,8 +16247,8 @@ def add_waterfall( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.waterfall.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. @@ -16310,8 +16314,8 @@ def add_waterfall( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.waterfall.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -16367,8 +16371,8 @@ def add_waterfall( Sets the source reference on plot.ly for texttemplate . totals - plotly.graph_objects.waterfall.Totals instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -17659,8 +17663,8 @@ def add_annotation( (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.annotation.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. @@ -18319,8 +18323,8 @@ def add_shape( Specifies whether shapes are drawn below or above traces. line - plotly.graph_objects.layout.shape.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure diff --git a/packages/python/plotly/plotly/graph_objs/_figurewidget.py b/packages/python/plotly/plotly/graph_objs/_figurewidget.py index b8200b2da2b..93df4e5c811 100644 --- a/packages/python/plotly/plotly/graph_objs/_figurewidget.py +++ b/packages/python/plotly/plotly/graph_objs/_figurewidget.py @@ -56,7 +56,7 @@ def __init__( self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs ): """ - Create a new FigureWidget instance + Create a new :class:FigureWidget instance Parameters ---------- @@ -93,18 +93,18 @@ def __init__( layout The 'layout' property is an instance of Layout that may be specified as: - - An instance of plotly.graph_objs.Layout + - An instance of :class:`plotly.graph_objs.Layout` - A dict of string/value properties that will be passed to the Layout constructor Supported dict properties: angularaxis - plotly.graph_objects.layout.AngularAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.AngularAxis + ` instance or dict with compatible properties annotations A tuple of - plotly.graph_objects.layout.Annotation + :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -183,11 +183,11 @@ def __init__( missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis - plotly.graph_objects.layout.Coloraxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Coloraxis` + instance or dict with compatible properties colorscale - plotly.graph_objects.layout.Colorscale instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties colorway Sets the default trace colors. datarevision @@ -285,11 +285,11 @@ def __init__( over one another, you might need to an "opacity" to see multiple bars. geo - plotly.graph_objects.layout.Geo instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Geo` + instance or dict with compatible properties grid - plotly.graph_objects.layout.Grid instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Grid` + instance or dict with compatible properties height Sets the plot's height (in px). hiddenlabels @@ -318,8 +318,8 @@ def __init__( objects will not supersede hover on point-like objects in case of conflict. hoverlabel - plotly.graph_objects.layout.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, @@ -330,7 +330,8 @@ def __init__( cartesian coordinates. For anything else the default value is "closest". images - A tuple of plotly.graph_objects.layout.Image + A tuple of + :class:`plotly.graph_objects.layout.Image` instances or dicts with compatible properties imagedefaults When used in a template (as @@ -338,14 +339,14 @@ def __init__( default property values to use for elements of layout.images legend - plotly.graph_objects.layout.Legend instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Legend` + instance or dict with compatible properties mapbox - plotly.graph_objects.layout.Mapbox instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Mapbox` + instance or dict with compatible properties margin - plotly.graph_objects.layout.Margin instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Margin` + instance or dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such @@ -362,8 +363,8 @@ def __init__( Sets the source reference on plot.ly for meta . modebar - plotly.graph_objects.layout.Modebar instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Modebar` + instance or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire @@ -382,14 +383,14 @@ def __init__( Sets the background color of the plotting area in-between x and y axes. polar - plotly.graph_objects.layout.Polar instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Polar` + instance or dict with compatible properties radialaxis - plotly.graph_objects.layout.RadialAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.RadialAxis` + instance or dict with compatible properties scene - plotly.graph_objects.layout.Scene instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Scene` + instance or dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, @@ -406,7 +407,8 @@ def __init__( dflt is ".," but other locales may alter this default. shapes - A tuple of plotly.graph_objects.layout.Shape + A tuple of + :class:`plotly.graph_objects.layout.Shape` instances or dicts with compatible properties shapedefaults When used in a template (as @@ -421,7 +423,8 @@ def __init__( trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders - A tuple of plotly.graph_objects.layout.Slider + A tuple of + :class:`plotly.graph_objects.layout.Slider` instances or dicts with compatible properties sliderdefaults When used in a template (as @@ -470,11 +473,11 @@ def __init__( plot, make an item with matching `templateitemname` and `visible: false`. ternary - plotly.graph_objects.layout.Ternary instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Ternary` + instance or dict with compatible properties title - plotly.graph_objects.layout.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the @@ -513,11 +516,11 @@ def __init__( range will reset but the x axis range will retain any user-driven zoom. uniformtext - plotly.graph_objects.layout.Uniformtext - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.Uniformtext + ` instance or dict with compatible properties updatemenus A tuple of - plotly.graph_objects.layout.Updatemenu + :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as @@ -558,11 +561,11 @@ def __init__( width Sets the plot's width (in px). xaxis - plotly.graph_objects.layout.XAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.XAxis` + instance or dict with compatible properties yaxis - plotly.graph_objects.layout.YAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.YAxis` + instance or dict with compatible properties frames The 'frames' property is a tuple of instances of @@ -658,8 +661,8 @@ def add_area( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.area.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.area.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -671,8 +674,8 @@ def add_area( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.area.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -703,8 +706,8 @@ def add_area( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.area.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.area.Stream` instance or + dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for @@ -892,11 +895,11 @@ def add_bar( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.bar.ErrorX instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties error_y - plotly.graph_objects.bar.ErrorY instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -905,8 +908,8 @@ def add_bar( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.bar.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -959,8 +962,8 @@ def add_bar( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.bar.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -1005,8 +1008,8 @@ def add_bar( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.bar.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -1018,8 +1021,8 @@ def add_bar( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.bar.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -1099,8 +1102,8 @@ def add_bar( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.bar.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -1317,8 +1320,8 @@ def add_barpolar( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.barpolar.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -1360,8 +1363,8 @@ def add_barpolar( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.barpolar.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -1396,8 +1399,8 @@ def add_barpolar( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.barpolar.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -1409,8 +1412,8 @@ def add_barpolar( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.barpolar.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -1457,8 +1460,8 @@ def add_barpolar( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.barpolar.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -1683,8 +1686,8 @@ def add_box( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.box.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? @@ -1734,8 +1737,8 @@ def add_box( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.box.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute @@ -1746,8 +1749,8 @@ def add_box( lowerfencesrc Sets the source reference on plot.ly for lowerfence . marker - plotly.graph_objects.box.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect @@ -1856,8 +1859,8 @@ def add_box( sdsrc Sets the source reference on plot.ly for sd . selected - plotly.graph_objects.box.Selected instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -1869,8 +1872,8 @@ def add_box( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.box.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -1903,8 +1906,8 @@ def add_box( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.box.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute @@ -2130,8 +2133,8 @@ def add_candlestick( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.candlestick.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties high Sets the high values. highsrc @@ -2144,8 +2147,8 @@ def add_candlestick( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.candlestick.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -2157,15 +2160,15 @@ def add_candlestick( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.candlestick.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.candlestick.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties low Sets the low values. lowsrc @@ -2205,8 +2208,8 @@ def add_candlestick( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.candlestick.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -2387,8 +2390,8 @@ def add_carpet( coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis - plotly.graph_objects.carpet.Aaxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties asrc Sets the source reference on plot.ly for a . b @@ -2399,8 +2402,8 @@ def add_carpet( coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis - plotly.graph_objects.carpet.Baxis instance or dict with - compatible properties + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet @@ -2457,8 +2460,8 @@ def add_carpet( opacity Sets the opacity of the trace. stream - plotly.graph_objects.carpet.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -2641,8 +2644,8 @@ def add_choropleth( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choropleth.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -2688,8 +2691,8 @@ def add_choropleth( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choropleth.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -2743,8 +2746,8 @@ def add_choropleth( locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choropleth.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -2768,8 +2771,8 @@ def add_choropleth( will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choropleth.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -2784,8 +2787,8 @@ def add_choropleth( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choropleth.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties text Sets the text elements associated with each location. textsrc @@ -2813,8 +2816,8 @@ def add_choropleth( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choropleth.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -2984,8 +2987,8 @@ def add_choroplethmapbox( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choroplethmapbox.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -3023,8 +3026,8 @@ def add_choroplethmapbox( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choroplethmapbox.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -3072,8 +3075,8 @@ def add_choroplethmapbox( locationssrc Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choroplethmapbox.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -3097,8 +3100,8 @@ def add_choroplethmapbox( will correspond to the last color in the array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choroplethmapbox.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -3113,8 +3116,8 @@ def add_choroplethmapbox( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choroplethmapbox.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -3147,8 +3150,8 @@ def add_choroplethmapbox( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choroplethmapbox.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -3342,8 +3345,8 @@ def add_cone( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.cone.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -3371,8 +3374,8 @@ def add_cone( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.cone.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -3415,11 +3418,11 @@ def add_cone( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.cone.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objects.cone.Lightposition instance or + :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -3480,8 +3483,8 @@ def add_cone( the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm. stream - plotly.graph_objects.cone.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and @@ -3710,8 +3713,8 @@ def add_contour( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contour.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -3730,8 +3733,8 @@ def add_contour( to true if `z` is a one dimensional array otherwise it is defaulted to false. contours - plotly.graph_objects.contour.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -3756,8 +3759,8 @@ def add_contour( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.contour.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -3803,8 +3806,8 @@ def add_contour( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contour.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -3842,8 +3845,8 @@ def add_contour( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contour.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -4148,8 +4151,8 @@ def add_contourcarpet( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contourcarpet.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -4163,8 +4166,8 @@ def add_contourcarpet( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.contourcarpet.Contours instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -4196,8 +4199,8 @@ def add_contourcarpet( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contourcarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -4235,8 +4238,8 @@ def add_contourcarpet( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contourcarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -4458,8 +4461,8 @@ def add_densitymapbox( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.densitymapbox.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -4487,8 +4490,8 @@ def add_densitymapbox( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.densitymapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -4579,8 +4582,8 @@ def add_densitymapbox( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.densitymapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -4791,8 +4794,8 @@ def add_funnel( and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.funnel.Connector instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -4815,8 +4818,8 @@ def add_funnel( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnel.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -4870,8 +4873,8 @@ def add_funnel( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnel.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -4922,8 +4925,8 @@ def add_funnel( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnel.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -5189,8 +5192,8 @@ def add_funnelarea( dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.funnelarea.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -5199,8 +5202,8 @@ def add_funnelarea( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnelarea.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -5262,8 +5265,8 @@ def add_funnelarea( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnelarea.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -5293,8 +5296,8 @@ def add_funnelarea( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnelarea.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -5333,8 +5336,8 @@ def add_funnelarea( Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.funnelarea.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -5528,8 +5531,8 @@ def add_heatmap( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmap.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -5566,8 +5569,8 @@ def add_heatmap( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated @@ -5643,8 +5646,8 @@ def add_heatmap( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -5908,8 +5911,8 @@ def add_heatmapgl( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmapgl.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -5941,8 +5944,8 @@ def add_heatmapgl( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmapgl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -5977,8 +5980,8 @@ def add_heatmapgl( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmapgl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.heatmapgl.Stream` instance + or dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -6237,8 +6240,8 @@ def add_histogram( can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup` cumulative - plotly.graph_objects.histogram.Cumulative instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -6247,11 +6250,11 @@ def add_histogram( customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.histogram.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.histogram.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties histfunc Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by @@ -6285,8 +6288,8 @@ def add_histogram( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -6329,8 +6332,8 @@ def add_histogram( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -6372,8 +6375,8 @@ def add_histogram( value of the each bar spans along the vertical (horizontal). selected - plotly.graph_objects.histogram.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -6385,8 +6388,8 @@ def add_histogram( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.histogram.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. @@ -6417,8 +6420,8 @@ def add_histogram( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.histogram.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -6432,8 +6435,8 @@ def add_histogram( x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins - plotly.graph_objects.histogram.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -6446,8 +6449,8 @@ def add_histogram( y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins - plotly.graph_objects.histogram.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -6636,8 +6639,8 @@ def add_histogram2d( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2d.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -6690,8 +6693,8 @@ def add_histogram2d( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -6730,8 +6733,8 @@ def add_histogram2d( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram2d.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -6775,8 +6778,8 @@ def add_histogram2d( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2d.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -6819,8 +6822,8 @@ def add_histogram2d( Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2d.XBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xgap @@ -6842,8 +6845,8 @@ def add_histogram2d( Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2d.YBins instance or dict - with compatible properties + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ygap @@ -7074,8 +7077,8 @@ def add_histogram2dcontour( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2dcontour.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -7089,8 +7092,8 @@ def add_histogram2dcontour( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contours - plotly.graph_objects.histogram2dcontour.Contours - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -7131,8 +7134,8 @@ def add_histogram2dcontour( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2dcontour.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -7171,11 +7174,11 @@ def add_histogram2dcontour( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.histogram2dcontour.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties marker - plotly.graph_objects.histogram2dcontour.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -7225,8 +7228,8 @@ def add_histogram2dcontour( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2dcontour.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -7269,8 +7272,8 @@ def add_histogram2dcontour( Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2dcontour.XBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. xsrc @@ -7290,8 +7293,8 @@ def add_histogram2dcontour( Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2dcontour.YBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. ysrc @@ -7480,8 +7483,8 @@ def add_image( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.image.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -7540,8 +7543,8 @@ def add_image( opacity Sets the opacity of the trace. stream - plotly.graph_objects.image.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties text Sets the text elements associated with each z value. textsrc @@ -7717,11 +7720,11 @@ def add_indicator( customdatasrc Sets the source reference on plot.ly for customdata . delta - plotly.graph_objects.indicator.Delta instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties domain - plotly.graph_objects.indicator.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties gauge The gauge of the Indicator plot. ids @@ -7755,14 +7758,14 @@ def add_indicator( Sets the trace name. The trace name appear as the legend item and on hover. number - plotly.graph_objects.indicator.Number instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties stream - plotly.graph_objects.indicator.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties title - plotly.graph_objects.indicator.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -7907,8 +7910,8 @@ def add_isosurface( chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.isosurface.Caps instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -7935,8 +7938,8 @@ def add_isosurface( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.isosurface.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -7950,8 +7953,8 @@ def add_isosurface( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.isosurface.Contour instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -7971,8 +7974,8 @@ def add_isosurface( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.isosurface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -8018,11 +8021,11 @@ def add_isosurface( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.isosurface.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.isosurface.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -8066,17 +8069,17 @@ def add_isosurface( Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.isosurface.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties spaceframe - plotly.graph_objects.isosurface.Spaceframe instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.isosurface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties surface - plotly.graph_objects.isosurface.Surface instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -8330,8 +8333,8 @@ def add_mesh3d( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.mesh3d.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -8345,8 +8348,8 @@ def add_mesh3d( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.mesh3d.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -8377,8 +8380,8 @@ def add_mesh3d( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.mesh3d.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -8461,11 +8464,11 @@ def add_mesh3d( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.mesh3d.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.mesh3d.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -8509,8 +8512,8 @@ def add_mesh3d( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.mesh3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -8730,8 +8733,8 @@ def add_ohlc( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.ohlc.Decreasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties high Sets the high values. highsrc @@ -8744,8 +8747,8 @@ def add_ohlc( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.ohlc.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -8757,15 +8760,15 @@ def add_ohlc( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.ohlc.Increasing instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.ohlc.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties low Sets the low values. lowsrc @@ -8805,8 +8808,8 @@ def add_ohlc( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.ohlc.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same string appears over @@ -8988,8 +8991,8 @@ def add_parcats( the default property values to use for elements of parcats.dimensions domain - plotly.graph_objects.parcats.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -9030,8 +9033,8 @@ def add_parcats( labelfont Sets the font for the `dimension` labels. line - plotly.graph_objects.parcats.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9056,8 +9059,8 @@ def add_parcats( If `backward`, sort paths based on dimensions categories from right to left. stream - plotly.graph_objects.parcats.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties tickfont Sets the font for the `category` labels. uid @@ -9177,8 +9180,8 @@ def add_parcoords( the default property values to use for elements of parcoords.dimensions domain - plotly.graph_objects.parcoords.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -9200,8 +9203,8 @@ def add_parcoords( may be positioned better inside margins when `labelposition` is set to "bottom". line - plotly.graph_objects.parcoords.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9223,8 +9226,8 @@ def add_parcoords( rangefont Sets the font for the `dimension` range values. stream - plotly.graph_objects.parcoords.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid @@ -9374,8 +9377,8 @@ def add_pie( dlabel Sets the label step. See `label0` for more info. domain - plotly.graph_objects.pie.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. @@ -9387,8 +9390,8 @@ def add_pie( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pie.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -9461,8 +9464,8 @@ def add_pie( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pie.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9508,8 +9511,8 @@ def add_pie( Determines whether or not the sectors are reordered from largest to smallest. stream - plotly.graph_objects.pie.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -9548,8 +9551,8 @@ def add_pie( Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.pie.Title instance or dict with - compatible properties + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the title's font used @@ -9724,8 +9727,8 @@ def add_pointcloud( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pointcloud.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -9748,8 +9751,8 @@ def add_pointcloud( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pointcloud.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -9774,8 +9777,8 @@ def add_pointcloud( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.pointcloud.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.pointcloud.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -9968,8 +9971,8 @@ def add_sankey( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sankey.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -9978,8 +9981,8 @@ def add_sankey( superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel - plotly.graph_objects.sankey.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -10018,8 +10021,8 @@ def add_sankey( any other non-array values means no selection all where the `selected` and `unselected` styles have no effect. stream - plotly.graph_objects.sankey.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties textfont Sets the font for node labels uid @@ -10199,11 +10202,11 @@ def add_scatter( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scatter.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -10250,8 +10253,8 @@ def add_scatter( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -10304,11 +10307,11 @@ def add_scatter( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties marker - plotly.graph_objects.scatter.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -10350,8 +10353,8 @@ def add_scatter( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatter.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -10387,8 +10390,8 @@ def add_scatter( fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order. stream - plotly.graph_objects.scatter.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the @@ -10455,8 +10458,8 @@ def add_scatter( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatter.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -10658,14 +10661,14 @@ def add_scatter3d( customdatasrc Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.scatter3d.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scatter3d.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties error_z - plotly.graph_objects.scatter3d.ErrorZ instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -10674,8 +10677,8 @@ def add_scatter3d( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter3d.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -10722,11 +10725,11 @@ def add_scatter3d( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter3d.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scatter3d.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -10755,8 +10758,8 @@ def add_scatter3d( opacity Sets the opacity of the trace. projection - plotly.graph_objects.scatter3d.Projection instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), @@ -10767,8 +10770,8 @@ def add_scatter3d( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatter3d.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a @@ -10784,8 +10787,8 @@ def add_scatter3d( flag and "hovertext" is not set, these elements will be seen in the hover labels. textfont - plotly.graph_objects.scatter3d.Textfont instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Textfont` + instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. @@ -11029,8 +11032,8 @@ def add_scattercarpet( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattercarpet.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -11082,11 +11085,11 @@ def add_scattercarpet( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattercarpet.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scattercarpet.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11115,8 +11118,8 @@ def add_scattercarpet( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattercarpet.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -11128,8 +11131,8 @@ def add_scattercarpet( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattercarpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the @@ -11191,8 +11194,8 @@ def add_scattercarpet( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattercarpet.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -11390,8 +11393,8 @@ def add_scattergeo( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergeo.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -11442,8 +11445,8 @@ def add_scattergeo( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergeo.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", @@ -11462,8 +11465,8 @@ def add_scattergeo( lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattergeo.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11492,8 +11495,8 @@ def add_scattergeo( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergeo.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -11505,8 +11508,8 @@ def add_scattergeo( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergeo.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same @@ -11569,8 +11572,8 @@ def add_scattergeo( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergeo.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -11724,11 +11727,11 @@ def add_scattergl( dy Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scattergl.ErrorX instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties error_y - plotly.graph_objects.scattergl.ErrorY instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets @@ -11764,8 +11767,8 @@ def add_scattergl( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergl.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -11812,11 +11815,11 @@ def add_scattergl( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergl.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties marker - plotly.graph_objects.scattergl.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -11840,8 +11843,8 @@ def add_scattergl( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergl.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -11853,8 +11856,8 @@ def add_scattergl( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergl.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -11915,8 +11918,8 @@ def add_scattergl( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergl.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -12121,8 +12124,8 @@ def add_scattermapbox( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattermapbox.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -12173,15 +12176,15 @@ def add_scattermapbox( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattermapbox.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattermapbox.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -12208,8 +12211,8 @@ def add_scattermapbox( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattermapbox.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -12221,8 +12224,8 @@ def add_scattermapbox( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattermapbox.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), @@ -12288,8 +12291,8 @@ def add_scattermapbox( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattermapbox.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -12468,8 +12471,8 @@ def add_scatterpolar( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolar.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -12522,11 +12525,11 @@ def add_scatterpolar( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolar.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolar.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -12563,8 +12566,8 @@ def add_scatterpolar( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolar.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -12576,8 +12579,8 @@ def add_scatterpolar( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolar.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -12655,8 +12658,8 @@ def add_scatterpolar( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolar.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -12845,8 +12848,8 @@ def add_scatterpolargl( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolargl.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -12893,11 +12896,11 @@ def add_scatterpolargl( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolargl.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterpolargl.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -12934,8 +12937,8 @@ def add_scatterpolargl( rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolargl.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -12947,8 +12950,8 @@ def add_scatterpolargl( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolargl.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), @@ -13026,8 +13029,8 @@ def add_scatterpolargl( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolargl.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -13223,8 +13226,8 @@ def add_scatterternary( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterternary.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they highlight filled @@ -13277,11 +13280,11 @@ def add_scatterternary( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterternary.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatterternary.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -13310,8 +13313,8 @@ def add_scatterternary( opacity Sets the opacity of the trace. selected - plotly.graph_objects.scatterternary.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -13323,8 +13326,8 @@ def add_scatterternary( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterternary.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default @@ -13398,8 +13401,8 @@ def add_scatterternary( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterternary.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -13531,11 +13534,12 @@ def add_splom( customdatasrc Sets the source reference on plot.ly for customdata . diagonal - plotly.graph_objects.splom.Diagonal instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties dimensions - A tuple of plotly.graph_objects.splom.Dimension - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties dimensiondefaults When used in a template (as layout.template.data.splom.dimensiondefaults), sets the @@ -13549,8 +13553,8 @@ def add_splom( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.splom.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -13592,8 +13596,8 @@ def add_splom( the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.splom.Marker instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -13615,8 +13619,8 @@ def add_splom( opacity Sets the opacity of the trace. selected - plotly.graph_objects.splom.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -13634,8 +13638,8 @@ def add_splom( Determines whether or not subplots on the upper half from the diagonal are displayed. stream - plotly.graph_objects.splom.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string @@ -13667,8 +13671,8 @@ def add_splom( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.splom.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -13845,8 +13849,8 @@ def add_streamtube( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.streamtube.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -13874,8 +13878,8 @@ def add_streamtube( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.streamtube.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -13917,11 +13921,11 @@ def add_streamtube( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.streamtube.Lighting instance or - dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties lightposition - plotly.graph_objects.streamtube.Lightposition instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties maxdisplayed The maximum number of displayed segments in a streamtube. @@ -13972,11 +13976,11 @@ def add_streamtube( 1, which avoids two max divergence tubes from touching at adjacent starting positions. starts - plotly.graph_objects.streamtube.Starts instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties stream - plotly.graph_objects.streamtube.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text @@ -14175,8 +14179,8 @@ def add_sunburst( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sunburst.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -14185,8 +14189,8 @@ def add_sunburst( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.sunburst.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -14247,8 +14251,8 @@ def add_sunburst( labelssrc Sets the source reference on plot.ly for labels . leaf - plotly.graph_objects.sunburst.Leaf instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root @@ -14256,8 +14260,8 @@ def add_sunburst( filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.sunburst.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -14299,8 +14303,8 @@ def add_sunburst( parentssrc Sets the source reference on plot.ly for parents . stream - plotly.graph_objects.sunburst.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -14530,8 +14534,8 @@ def add_surface( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.surface.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -14548,8 +14552,8 @@ def add_surface( Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours - plotly.graph_objects.surface.Contours instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -14570,8 +14574,8 @@ def add_surface( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.surface.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -14613,11 +14617,11 @@ def add_surface( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.surface.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.surface.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -14661,8 +14665,8 @@ def add_surface( Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.surface.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. @@ -14828,8 +14832,8 @@ def add_table( Parameters ---------- cells - plotly.graph_objects.table.Cells instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column @@ -14851,11 +14855,11 @@ def add_table( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.table.Domain instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties header - plotly.graph_objects.table.Header instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -14864,8 +14868,8 @@ def add_table( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.table.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an @@ -14891,8 +14895,8 @@ def add_table( Sets the trace name. The trace name appear as the legend item and on hover. stream - plotly.graph_objects.table.Stream instance or dict with - compatible properties + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -15036,8 +15040,8 @@ def add_treemap( customdatasrc Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.treemap.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed @@ -15046,8 +15050,8 @@ def add_treemap( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.treemap.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -15104,8 +15108,8 @@ def add_treemap( filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.treemap.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the @@ -15147,11 +15151,11 @@ def add_treemap( parentssrc Sets the source reference on plot.ly for parents . pathbar - plotly.graph_objects.treemap.Pathbar instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties stream - plotly.graph_objects.treemap.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements @@ -15188,8 +15192,8 @@ def add_treemap( Sets the source reference on plot.ly for texttemplate . tiling - plotly.graph_objects.treemap.Tiling instance or dict - with compatible properties + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -15365,8 +15369,8 @@ def add_violin( estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box - plotly.graph_objects.violin.Box instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -15386,8 +15390,8 @@ def add_violin( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.violin.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density estimate or any @@ -15438,14 +15442,14 @@ def add_violin( the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.violin.Line instance or dict with - compatible properties + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties marker - plotly.graph_objects.violin.Marker instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties meanline - plotly.graph_objects.violin.Meanline instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -15510,8 +15514,8 @@ def add_violin( width*count* means the violins are scaled by the number of sample points makingup each violin. selected - plotly.graph_objects.violin.Selected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that support selections. @@ -15542,8 +15546,8 @@ def add_violin( settings, use mode "manual" and fill in the `span` attribute. stream - plotly.graph_objects.violin.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same string appears over @@ -15576,8 +15580,8 @@ def add_violin( preserve user-driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.violin.Unselected instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as @@ -15776,8 +15780,8 @@ def add_volume( chosen according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.volume.Caps instance or dict with - compatible properties + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here `value`) or the @@ -15804,8 +15808,8 @@ def add_volume( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.volume.ColorBar instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -15819,8 +15823,8 @@ def add_volume( d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis. contour - plotly.graph_objects.volume.Contour instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note @@ -15840,8 +15844,8 @@ def add_volume( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.volume.Hoverlabel instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -15887,11 +15891,11 @@ def add_volume( the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.volume.Lighting instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties lightposition - plotly.graph_objects.volume.Lightposition instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text attributes. @@ -15946,17 +15950,17 @@ def add_volume( Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.volume.Slices instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties spaceframe - plotly.graph_objects.volume.Spaceframe instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.volume.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties surface - plotly.graph_objects.volume.Surface instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and @@ -16171,8 +16175,8 @@ def add_waterfall( and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.waterfall.Connector instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -16184,8 +16188,8 @@ def add_waterfall( customdatasrc Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.waterfall.Decreasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. dy @@ -16198,8 +16202,8 @@ def add_waterfall( hoverinfosrc Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.waterfall.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -16243,8 +16247,8 @@ def add_waterfall( idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.waterfall.Increasing instance or - dict with compatible properties + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" mode. @@ -16310,8 +16314,8 @@ def add_waterfall( Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.waterfall.Stream instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the @@ -16367,8 +16371,8 @@ def add_waterfall( Sets the source reference on plot.ly for texttemplate . totals - plotly.graph_objects.waterfall.Totals instance or dict - with compatible properties + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during animations and @@ -17659,8 +17663,8 @@ def add_annotation( (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.annotation.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. @@ -18319,8 +18323,8 @@ def add_shape( Specifies whether shapes are drawn below or above traces. line - plotly.graph_objects.layout.shape.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure diff --git a/packages/python/plotly/plotly/graph_objs/area/__init__.py b/packages/python/plotly/plotly/graph_objs/area/__init__.py index 3b1f3beb6fe..ff1abd84d03 100644 --- a/packages/python/plotly/plotly/graph_objs/area/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/area/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.Stream + an instance of :class:`plotly.graph_objs.area.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.area.Stream constructor must be a dict or -an instance of plotly.graph_objs.area.Stream""" +an instance of :class:`plotly.graph_objs.area.Stream`""" ) # Handle skip_invalid @@ -481,7 +481,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.Marker + an instance of :class:`plotly.graph_objs.area.Marker` color Area traces are deprecated! Please switch to the "barpolar" trace type. Sets themarkercolor. It accepts @@ -530,7 +530,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.area.Marker constructor must be a dict or -an instance of plotly.graph_objs.area.Marker""" +an instance of :class:`plotly.graph_objs.area.Marker`""" ) # Handle skip_invalid @@ -799,7 +799,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.area.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.area.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -954,7 +954,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.Hoverlabel + an instance of + :class:`plotly.graph_objs.area.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1003,7 +1004,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.area.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.area.Hoverlabel""" +an instance of :class:`plotly.graph_objs.area.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/area/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/area/hoverlabel/__init__.py index 61847588bc0..ae9ecd8495e 100644 --- a/packages/python/plotly/plotly/graph_objs/area/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/area/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.area.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.area.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.area.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.area.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/__init__.py index 6cbb79d97f3..e47694ea923 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.bar.unselected.Marker + - An instance of :class:`plotly.graph_objs.bar.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -41,7 +41,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.bar.unselected.Textfont + - An instance of :class:`plotly.graph_objs.bar.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -73,11 +73,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.bar.unselected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Marker` + instance or dict with compatible properties textfont - plotly.graph_objects.bar.unselected.Textfont instance - or dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Textfont` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -88,13 +88,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Unselected + an instance of + :class:`plotly.graph_objs.bar.Unselected` marker - plotly.graph_objects.bar.unselected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Marker` + instance or dict with compatible properties textfont - plotly.graph_objects.bar.unselected.Textfont instance - or dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Textfont` + instance or dict with compatible properties Returns ------- @@ -115,7 +116,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.Unselected constructor must be a dict or -an instance of plotly.graph_objs.bar.Unselected""" +an instance of :class:`plotly.graph_objs.bar.Unselected`""" ) # Handle skip_invalid @@ -379,7 +380,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Textfont + an instance of :class:`plotly.graph_objs.bar.Textfont` color colorsrc @@ -424,7 +425,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.Textfont constructor must be a dict or -an instance of plotly.graph_objs.bar.Textfont""" +an instance of :class:`plotly.graph_objs.bar.Textfont`""" ) # Handle skip_invalid @@ -547,7 +548,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Stream + an instance of :class:`plotly.graph_objs.bar.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -577,7 +578,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.Stream constructor must be a dict or -an instance of plotly.graph_objs.bar.Stream""" +an instance of :class:`plotly.graph_objs.bar.Stream`""" ) # Handle skip_invalid @@ -622,7 +623,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.bar.selected.Marker + - An instance of :class:`plotly.graph_objs.bar.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -650,7 +651,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.bar.selected.Textfont + - An instance of :class:`plotly.graph_objs.bar.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -681,11 +682,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.bar.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Marker` + instance or dict with compatible properties textfont - plotly.graph_objects.bar.selected.Textfont instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Textfont` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -696,13 +697,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Selected + an instance of :class:`plotly.graph_objs.bar.Selected` marker - plotly.graph_objects.bar.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Marker` + instance or dict with compatible properties textfont - plotly.graph_objects.bar.selected.Textfont instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Textfont` + instance or dict with compatible properties Returns ------- @@ -723,7 +724,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.Selected constructor must be a dict or -an instance of plotly.graph_objs.bar.Selected""" +an instance of :class:`plotly.graph_objs.bar.Selected`""" ) # Handle skip_invalid @@ -987,7 +988,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Outsidetextfont + an instance of + :class:`plotly.graph_objs.bar.Outsidetextfont` color colorsrc @@ -1032,7 +1034,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.Outsidetextfont constructor must be a dict or -an instance of plotly.graph_objs.bar.Outsidetextfont""" +an instance of :class:`plotly.graph_objs.bar.Outsidetextfont`""" ) # Handle skip_invalid @@ -1302,7 +1304,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.bar.marker.ColorBar + - An instance of :class:`plotly.graph_objs.bar.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1434,9 +1436,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.bar.marker.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.bar.mar + ker.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.bar.marker.colorbar.tickformatstopdefaults), @@ -1482,8 +1484,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.bar.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use bar.marker.colorbar.title.font instead. Sets @@ -1609,7 +1612,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.bar.marker.Line + - An instance of :class:`plotly.graph_objs.bar.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1858,8 +1861,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.bar.marker.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1877,8 +1880,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.bar.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.marker.Line` instance + or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1922,7 +1925,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Marker + an instance of :class:`plotly.graph_objs.bar.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1970,8 +1973,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.bar.marker.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1989,8 +1992,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.bar.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.bar.marker.Line` instance + or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -2025,7 +2028,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.Marker constructor must be a dict or -an instance of plotly.graph_objs.bar.Marker""" +an instance of :class:`plotly.graph_objs.bar.Marker`""" ) # Handle skip_invalid @@ -2328,7 +2331,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Insidetextfont + an instance of + :class:`plotly.graph_objs.bar.Insidetextfont` color colorsrc @@ -2373,7 +2377,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.bar.Insidetextfont""" +an instance of :class:`plotly.graph_objs.bar.Insidetextfont`""" ) # Handle skip_invalid @@ -2636,7 +2640,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.bar.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.bar.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2791,7 +2795,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Hoverlabel + an instance of + :class:`plotly.graph_objs.bar.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2840,7 +2845,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.bar.Hoverlabel""" +an instance of :class:`plotly.graph_objs.bar.Hoverlabel`""" ) # Handle skip_invalid @@ -3324,7 +3329,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.ErrorY + an instance of :class:`plotly.graph_objs.bar.ErrorY` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3396,7 +3401,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.ErrorY constructor must be a dict or -an instance of plotly.graph_objs.bar.ErrorY""" +an instance of :class:`plotly.graph_objs.bar.ErrorY`""" ) # Handle skip_invalid @@ -3916,7 +3921,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.ErrorX + an instance of :class:`plotly.graph_objs.bar.ErrorX` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3990,7 +3995,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.ErrorX constructor must be a dict or -an instance of plotly.graph_objs.bar.ErrorX""" +an instance of :class:`plotly.graph_objs.bar.ErrorX`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/__init__.py index a826bc2a272..d1ae03c9ade 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.bar.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.bar.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.bar.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/marker/__init__.py index 20d2cdd96f3..38560a36a6f 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.marker.Line + an instance of + :class:`plotly.graph_objs.bar.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.Line""" +an instance of :class:`plotly.graph_objs.bar.marker.Line`""" ) # Handle skip_invalid @@ -1258,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.bar.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1391,7 +1392,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.bar.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1629,7 +1630,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.bar.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1672,7 +1673,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.bar.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1981,9 +1982,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.bar.marker.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.bar.marker.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.bar.ma rker.colorbar.tickformatstopdefaults), sets the default @@ -2023,8 +2024,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.bar.marker.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use bar.marker.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2118,7 +2119,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.marker.ColorBar + an instance of + :class:`plotly.graph_objs.bar.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2231,9 +2233,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.bar.marker.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.bar.marker.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.bar.ma rker.colorbar.tickformatstopdefaults), sets the default @@ -2273,8 +2275,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.bar.marker.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use bar.marker.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2326,7 +2328,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.bar.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/__init__.py index c2b37ed943e..d8f8b644cf0 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.bar.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.bar.marker.colorbar.Title + :class:`plotly.graph_objs.bar.marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.marker.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.bar.marker.col + orbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -644,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.bar.marker.colorbar.Tickfont + :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/__init__.py index a52e2873681..0c104d1a514 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.bar.marker.col + orbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/selected/__init__.py index 1e26ec305eb..7eae5c02bc3 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/selected/__init__.py @@ -86,7 +86,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.selected.Textfont + an instance of + :class:`plotly.graph_objs.bar.selected.Textfont` color Sets the text font color of selected points. @@ -109,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.bar.selected.Textfont""" +an instance of :class:`plotly.graph_objs.bar.selected.Textfont`""" ) # Handle skip_invalid @@ -248,7 +249,8 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.selected.Marker + an instance of + :class:`plotly.graph_objs.bar.selected.Marker` color Sets the marker color of selected points. opacity @@ -273,7 +275,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.bar.selected.Marker""" +an instance of :class:`plotly.graph_objs.bar.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/bar/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/bar/unselected/__init__.py index d1621a6442b..224457087d5 100644 --- a/packages/python/plotly/plotly/graph_objs/bar/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/bar/unselected/__init__.py @@ -89,7 +89,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.bar.unselected.Textfont + :class:`plotly.graph_objs.bar.unselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.bar.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.bar.unselected.Textfont`""" ) # Handle skip_invalid @@ -256,7 +256,8 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.unselected.Marker + an instance of + :class:`plotly.graph_objs.bar.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -283,7 +284,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.bar.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.bar.unselected.Marker""" +an instance of :class:`plotly.graph_objs.bar.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/__init__.py index 53aacfc76ed..e90535daf63 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.barpolar.unselected.Marker + - An instance of :class:`plotly.graph_objs.barpolar.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -41,7 +41,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.barpolar.unselected.Textfont + - An instance of :class:`plotly.graph_objs.barpolar.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -73,11 +73,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.barpolar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselected.Marker + ` instance or dict with compatible properties textfont - plotly.graph_objects.barpolar.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselected.Textfo + nt` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -88,13 +88,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Unselected + an instance of + :class:`plotly.graph_objs.barpolar.Unselected` marker - plotly.graph_objects.barpolar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselected.Marker + ` instance or dict with compatible properties textfont - plotly.graph_objects.barpolar.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselected.Textfo + nt` instance or dict with compatible properties Returns ------- @@ -115,7 +116,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.Unselected constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Unselected""" +an instance of :class:`plotly.graph_objs.barpolar.Unselected`""" ) # Handle skip_invalid @@ -226,7 +227,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Stream + an instance of + :class:`plotly.graph_objs.barpolar.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -256,7 +258,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.Stream constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Stream""" +an instance of :class:`plotly.graph_objs.barpolar.Stream`""" ) # Handle skip_invalid @@ -301,7 +303,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.barpolar.selected.Marker + - An instance of :class:`plotly.graph_objs.barpolar.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -329,7 +331,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.barpolar.selected.Textfont + - An instance of :class:`plotly.graph_objs.barpolar.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -360,11 +362,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.barpolar.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.barpolar.selected.Textfont + :class:`plotly.graph_objects.barpolar.selected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.barpolar.selected.Textfont + ` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -375,13 +377,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Selected + an instance of + :class:`plotly.graph_objs.barpolar.Selected` marker - plotly.graph_objects.barpolar.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.barpolar.selected.Textfont + :class:`plotly.graph_objects.barpolar.selected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.barpolar.selected.Textfont + ` instance or dict with compatible properties Returns ------- @@ -402,7 +405,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.Selected constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Selected""" +an instance of :class:`plotly.graph_objs.barpolar.Selected`""" ) # Handle skip_invalid @@ -660,7 +663,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.ColorBar + - An instance of :class:`plotly.graph_objs.barpolar.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -792,9 +795,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.barpolar.marker - .colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.barpola + r.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.barpolar.marker.colorbar.tickformatstopdefaul @@ -841,8 +844,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.barpolar.marker.colorbar.T - itle instance or dict with compatible + :class:`plotly.graph_objects.barpolar.marker.co + lorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -969,7 +972,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.Line + - An instance of :class:`plotly.graph_objs.barpolar.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1218,8 +1221,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.barpolar.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1237,8 +1240,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.barpolar.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1282,7 +1285,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Marker + an instance of + :class:`plotly.graph_objs.barpolar.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1330,8 +1334,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.barpolar.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1349,8 +1353,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.barpolar.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1385,7 +1389,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.barpolar.Marker constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Marker""" +an instance of :class:`plotly.graph_objs.barpolar.Marker`""" ) # Handle skip_invalid @@ -1675,7 +1679,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.barpolar.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.barpolar.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1830,7 +1834,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Hoverlabel + an instance of + :class:`plotly.graph_objs.barpolar.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1879,7 +1884,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.barpolar.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Hoverlabel""" +an instance of :class:`plotly.graph_objs.barpolar.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/__init__.py index 6d96546f65b..aa8dc1c2c3e 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.barpolar.hoverlabel.Font + :class:`plotly.graph_objs.barpolar.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.barpolar.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.barpolar.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.barpolar.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/__init__.py index 56d9169f0ad..395a8b10094 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.marker.Line + an instance of + :class:`plotly.graph_objs.barpolar.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.barpolar.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.Line""" +an instance of :class:`plotly.graph_objs.barpolar.marker.Line`""" ) # Handle skip_invalid @@ -1258,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1392,7 +1393,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1630,7 +1631,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1674,7 +1675,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1983,9 +1984,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.barpolar.marker.colorba - r.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.barpolar.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.barpol ar.marker.colorbar.tickformatstopdefaults), sets the @@ -2025,8 +2026,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.barpolar.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.colorbar.T + itle` instance or dict with compatible properties titlefont Deprecated: Please use barpolar.marker.colorbar.title.font instead. Sets this @@ -2121,7 +2122,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.barpolar.marker.ColorBar + :class:`plotly.graph_objs.barpolar.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2234,9 +2235,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.barpolar.marker.colorba - r.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.barpolar.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.barpol ar.marker.colorbar.tickformatstopdefaults), sets the @@ -2276,8 +2277,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.barpolar.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.colorbar.T + itle` instance or dict with compatible properties titlefont Deprecated: Please use barpolar.marker.colorbar.title.font instead. Sets this @@ -2329,7 +2330,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.barpolar.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.barpolar.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/__init__.py index bfd8a5640be..257fddd702d 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.barpolar.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.marker.colorb - ar.Tickformatstop + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py index 9483d27eeda..ab1dcec9125 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/selected/__init__.py index f0c573c07d0..f828d37670f 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/selected/__init__.py @@ -87,7 +87,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.barpolar.selected.Textfont + :class:`plotly.graph_objs.barpolar.selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.barpolar.selected.Textfont""" +an instance of :class:`plotly.graph_objs.barpolar.selected.Textfont`""" ) # Handle skip_invalid @@ -250,7 +250,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.barpolar.selected.Marker + :class:`plotly.graph_objs.barpolar.selected.Marker` color Sets the marker color of selected points. opacity @@ -275,7 +275,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.barpolar.selected.Marker""" +an instance of :class:`plotly.graph_objs.barpolar.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/barpolar/unselected/__init__.py index d6bc14d7f2b..c8be9004256 100644 --- a/packages/python/plotly/plotly/graph_objs/barpolar/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/barpolar/unselected/__init__.py @@ -89,7 +89,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.barpolar.unselected.Textfont + :class:`plotly.graph_objs.barpolar.unselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.barpolar.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.barpolar.unselected.Textfont`""" ) # Handle skip_invalid @@ -257,7 +257,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.barpolar.unselected.Marker + :class:`plotly.graph_objs.barpolar.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -284,7 +284,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.barpolar.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.barpolar.unselected.Marker""" +an instance of :class:`plotly.graph_objs.barpolar.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/box/__init__.py b/packages/python/plotly/plotly/graph_objs/box/__init__.py index cf908545b0d..e6ab89fe9e0 100644 --- a/packages/python/plotly/plotly/graph_objs/box/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/box/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.box.unselected.Marker + - An instance of :class:`plotly.graph_objs.box.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -49,8 +49,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.box.unselected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.box.unselected.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -61,10 +61,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Unselected + an instance of + :class:`plotly.graph_objs.box.Unselected` marker - plotly.graph_objects.box.unselected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.box.unselected.Marker` + instance or dict with compatible properties Returns ------- @@ -85,7 +86,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.box.Unselected constructor must be a dict or -an instance of plotly.graph_objs.box.Unselected""" +an instance of :class:`plotly.graph_objs.box.Unselected`""" ) # Handle skip_invalid @@ -193,7 +194,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Stream + an instance of :class:`plotly.graph_objs.box.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -223,7 +224,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.box.Stream constructor must be a dict or -an instance of plotly.graph_objs.box.Stream""" +an instance of :class:`plotly.graph_objs.box.Stream`""" ) # Handle skip_invalid @@ -268,7 +269,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.box.selected.Marker + - An instance of :class:`plotly.graph_objs.box.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -303,8 +304,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.box.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.box.selected.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -315,10 +316,10 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Selected + an instance of :class:`plotly.graph_objs.box.Selected` marker - plotly.graph_objects.box.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.box.selected.Marker` + instance or dict with compatible properties Returns ------- @@ -339,7 +340,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.box.Selected constructor must be a dict or -an instance of plotly.graph_objs.box.Selected""" +an instance of :class:`plotly.graph_objs.box.Selected`""" ) # Handle skip_invalid @@ -443,7 +444,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.box.marker.Line + - An instance of :class:`plotly.graph_objs.box.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -677,8 +678,8 @@ def _prop_descriptions(self): array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.box.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.box.marker.Line` instance + or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -711,7 +712,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Marker + an instance of :class:`plotly.graph_objs.box.Marker` color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the @@ -719,8 +720,8 @@ def __init__( array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.box.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.box.marker.Line` instance + or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -753,7 +754,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.box.Marker constructor must be a dict or -an instance of plotly.graph_objs.box.Marker""" +an instance of :class:`plotly.graph_objs.box.Marker`""" ) # Handle skip_invalid @@ -907,7 +908,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Line + an instance of :class:`plotly.graph_objs.box.Line` color Sets the color of line bounding the box(es). width @@ -932,7 +933,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.box.Line constructor must be a dict or -an instance of plotly.graph_objs.box.Line""" +an instance of :class:`plotly.graph_objs.box.Line`""" ) # Handle skip_invalid @@ -1183,7 +1184,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.box.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.box.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1338,7 +1339,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Hoverlabel + an instance of + :class:`plotly.graph_objs.box.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1387,7 +1389,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.box.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.box.Hoverlabel""" +an instance of :class:`plotly.graph_objs.box.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/box/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/box/hoverlabel/__init__.py index a42b9bb4b92..48ae0396ac5 100644 --- a/packages/python/plotly/plotly/graph_objs/box/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/box/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.box.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.box.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.box.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.box.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/box/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/box/marker/__init__.py index 79b6f6b71d7..77cfb8e4fbf 100644 --- a/packages/python/plotly/plotly/graph_objs/box/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/box/marker/__init__.py @@ -211,7 +211,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.marker.Line + an instance of + :class:`plotly.graph_objs.box.marker.Line` color Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the @@ -247,7 +248,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.box.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.box.marker.Line""" +an instance of :class:`plotly.graph_objs.box.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/box/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/box/selected/__init__.py index a70465d7215..55ec4d70f33 100644 --- a/packages/python/plotly/plotly/graph_objs/box/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/box/selected/__init__.py @@ -130,7 +130,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.selected.Marker + an instance of + :class:`plotly.graph_objs.box.selected.Marker` color Sets the marker color of selected points. opacity @@ -157,7 +158,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.box.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.box.selected.Marker""" +an instance of :class:`plotly.graph_objs.box.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/box/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/box/unselected/__init__.py index e463415a7a1..1bbc01c2ca1 100644 --- a/packages/python/plotly/plotly/graph_objs/box/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/box/unselected/__init__.py @@ -136,7 +136,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.unselected.Marker + an instance of + :class:`plotly.graph_objs.box.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -166,7 +167,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.box.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.box.unselected.Marker""" +an instance of :class:`plotly.graph_objs.box.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/__init__.py b/packages/python/plotly/plotly/graph_objs/candlestick/__init__.py index 30435897c6b..29a2327d7c9 100644 --- a/packages/python/plotly/plotly/graph_objs/candlestick/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/candlestick/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Stream + an instance of + :class:`plotly.graph_objs.candlestick.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.candlestick.Stream constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Stream""" +an instance of :class:`plotly.graph_objs.candlestick.Stream`""" ) # Handle skip_invalid @@ -193,7 +194,8 @@ def __init__(self, arg=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Line + an instance of + :class:`plotly.graph_objs.candlestick.Line` width Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per @@ -219,7 +221,7 @@ def __init__(self, arg=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.candlestick.Line constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Line""" +an instance of :class:`plotly.graph_objs.candlestick.Line`""" ) # Handle skip_invalid @@ -322,7 +324,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.candlestick.increasing.Line + - An instance of :class:`plotly.graph_objs.candlestick.increasing.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -360,8 +362,8 @@ def _prop_descriptions(self): variant of the line color, marker color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.increasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.increasing.Lin + e` instance or dict with compatible properties """ def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): @@ -372,14 +374,15 @@ def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Increasing + an instance of + :class:`plotly.graph_objs.candlestick.Increasing` fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.increasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.increasing.Lin + e` instance or dict with compatible properties Returns ------- @@ -400,7 +403,7 @@ def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.candlestick.Increasing constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Increasing""" +an instance of :class:`plotly.graph_objs.candlestick.Increasing`""" ) # Handle skip_invalid @@ -651,7 +654,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.candlestick.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.candlestick.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -831,7 +834,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Hoverlabel + an instance of + :class:`plotly.graph_objs.candlestick.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -883,7 +887,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.candlestick.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Hoverlabel""" +an instance of :class:`plotly.graph_objs.candlestick.Hoverlabel`""" ) # Handle skip_invalid @@ -1013,7 +1017,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.candlestick.decreasing.Line + - An instance of :class:`plotly.graph_objs.candlestick.decreasing.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1051,8 +1055,8 @@ def _prop_descriptions(self): variant of the line color, marker color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.decreasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.decreasing.Lin + e` instance or dict with compatible properties """ def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): @@ -1063,14 +1067,15 @@ def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Decreasing + an instance of + :class:`plotly.graph_objs.candlestick.Decreasing` fillcolor Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.decreasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.decreasing.Lin + e` instance or dict with compatible properties Returns ------- @@ -1091,7 +1096,7 @@ def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.candlestick.Decreasing constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Decreasing""" +an instance of :class:`plotly.graph_objs.candlestick.Decreasing`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/__init__.py b/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/__init__.py index dc90e68fee9..f8810c3003e 100644 --- a/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/__init__.py @@ -109,7 +109,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.candlestick.decreasing.Line + :class:`plotly.graph_objs.candlestick.decreasing.Line` color Sets the color of line bounding the box(es). width @@ -134,7 +134,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.candlestick.decreasing.Line constructor must be a dict or -an instance of plotly.graph_objs.candlestick.decreasing.Line""" +an instance of :class:`plotly.graph_objs.candlestick.decreasing.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/__init__.py index cbb2341a0e3..358de25a2cb 100644 --- a/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.candlestick.hoverlabel.Font + :class:`plotly.graph_objs.candlestick.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.candlestick.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.candlestick.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.candlestick.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/increasing/__init__.py b/packages/python/plotly/plotly/graph_objs/candlestick/increasing/__init__.py index ad2f0e688e3..09e2aa04027 100644 --- a/packages/python/plotly/plotly/graph_objs/candlestick/increasing/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/candlestick/increasing/__init__.py @@ -109,7 +109,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.candlestick.increasing.Line + :class:`plotly.graph_objs.candlestick.increasing.Line` color Sets the color of line bounding the box(es). width @@ -134,7 +134,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.candlestick.increasing.Line constructor must be a dict or -an instance of plotly.graph_objs.candlestick.increasing.Line""" +an instance of :class:`plotly.graph_objs.candlestick.increasing.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/carpet/__init__.py b/packages/python/plotly/plotly/graph_objs/carpet/__init__.py index 015c3cda9ce..7614071b148 100644 --- a/packages/python/plotly/plotly/graph_objs/carpet/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/carpet/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Stream + an instance of :class:`plotly.graph_objs.carpet.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.Stream constructor must be a dict or -an instance of plotly.graph_objs.carpet.Stream""" +an instance of :class:`plotly.graph_objs.carpet.Stream`""" ) # Handle skip_invalid @@ -292,7 +292,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Font + an instance of :class:`plotly.graph_objs.carpet.Font` color family @@ -331,7 +331,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.Font constructor must be a dict or -an instance of plotly.graph_objs.carpet.Font""" +an instance of :class:`plotly.graph_objs.carpet.Font`""" ) # Handle skip_invalid @@ -1481,7 +1481,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.carpet.baxis.Tickfont + - An instance of :class:`plotly.graph_objs.carpet.baxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1614,7 +1614,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.carpet.baxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.carpet.baxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1781,7 +1781,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.carpet.baxis.Title + - An instance of :class:`plotly.graph_objs.carpet.baxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1824,7 +1824,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.carpet.baxis.title.Font + - An instance of :class:`plotly.graph_objs.carpet.baxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2067,9 +2067,9 @@ def _prop_descriptions(self): example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.carpet.baxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.carpet.baxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.carpet .baxis.tickformatstopdefaults), sets the default @@ -2094,8 +2094,8 @@ def _prop_descriptions(self): tickvalssrc Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.baxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.baxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use carpet.baxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -2185,7 +2185,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Baxis + an instance of :class:`plotly.graph_objs.carpet.Baxis` arraydtick The stride between grid lines along the axis arraytick0 @@ -2336,9 +2336,9 @@ def __init__( example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.carpet.baxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.carpet.baxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.carpet .baxis.tickformatstopdefaults), sets the default @@ -2363,8 +2363,8 @@ def __init__( tickvalssrc Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.baxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.baxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use carpet.baxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -2400,7 +2400,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.carpet.Baxis constructor must be a dict or -an instance of plotly.graph_objs.carpet.Baxis""" +an instance of :class:`plotly.graph_objs.carpet.Baxis`""" ) # Handle skip_invalid @@ -3714,7 +3714,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.carpet.aaxis.Tickfont + - An instance of :class:`plotly.graph_objs.carpet.aaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -3847,7 +3847,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.carpet.aaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -4014,7 +4014,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.carpet.aaxis.Title + - An instance of :class:`plotly.graph_objs.carpet.aaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -4057,7 +4057,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.carpet.aaxis.title.Font + - An instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -4300,9 +4300,9 @@ def _prop_descriptions(self): example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.carpet.aaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.carpet.aaxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.carpet .aaxis.tickformatstopdefaults), sets the default @@ -4327,8 +4327,8 @@ def _prop_descriptions(self): tickvalssrc Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.aaxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.aaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use carpet.aaxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -4418,7 +4418,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Aaxis + an instance of :class:`plotly.graph_objs.carpet.Aaxis` arraydtick The stride between grid lines along the axis arraytick0 @@ -4569,9 +4569,9 @@ def __init__( example, *2016-10-13 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.carpet.aaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.carpet.aaxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.carpet .aaxis.tickformatstopdefaults), sets the default @@ -4596,8 +4596,8 @@ def __init__( tickvalssrc Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.aaxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.aaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use carpet.aaxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -4633,7 +4633,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.carpet.Aaxis constructor must be a dict or -an instance of plotly.graph_objs.carpet.Aaxis""" +an instance of :class:`plotly.graph_objs.carpet.Aaxis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/__init__.py index a3dc5316a5c..d15d76f8b53 100644 --- a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.carpet.aaxis.title.Font + - An instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -130,7 +130,8 @@ def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.aaxis.Title + an instance of + :class:`plotly.graph_objs.carpet.aaxis.Title` font Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -165,7 +166,7 @@ def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.aaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.Title""" +an instance of :class:`plotly.graph_objs.carpet.aaxis.Title`""" ) # Handle skip_invalid @@ -390,7 +391,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.carpet.aaxis.Tickformatstop + :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -441,7 +442,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.carpet.aaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -639,7 +640,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.aaxis.Tickfont + an instance of + :class:`plotly.graph_objs.carpet.aaxis.Tickfont` color family @@ -678,7 +680,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.aaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.carpet.aaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/__init__.py index e7b71be0dde..01bc6681702 100644 --- a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.carpet.aaxis.title.Font + :class:`plotly.graph_objs.carpet.aaxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.aaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.title.Font""" +an instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/carpet/baxis/__init__.py b/packages/python/plotly/plotly/graph_objs/carpet/baxis/__init__.py index a13a4819227..6e8822f8cae 100644 --- a/packages/python/plotly/plotly/graph_objs/carpet/baxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/carpet/baxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.carpet.baxis.title.Font + - An instance of :class:`plotly.graph_objs.carpet.baxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -130,7 +130,8 @@ def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.baxis.Title + an instance of + :class:`plotly.graph_objs.carpet.baxis.Title` font Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -165,7 +166,7 @@ def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.baxis.Title constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.Title""" +an instance of :class:`plotly.graph_objs.carpet.baxis.Title`""" ) # Handle skip_invalid @@ -390,7 +391,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.carpet.baxis.Tickformatstop + :class:`plotly.graph_objs.carpet.baxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -441,7 +442,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.carpet.baxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.carpet.baxis.Tickformatstop`""" ) # Handle skip_invalid @@ -639,7 +640,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.baxis.Tickfont + an instance of + :class:`plotly.graph_objs.carpet.baxis.Tickfont` color family @@ -678,7 +680,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.baxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.Tickfont""" +an instance of :class:`plotly.graph_objs.carpet.baxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/__init__.py index 85e44744821..f4ecdabee93 100644 --- a/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.carpet.baxis.title.Font + :class:`plotly.graph_objs.carpet.baxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.carpet.baxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.title.Font""" +an instance of :class:`plotly.graph_objs.carpet.baxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/__init__.py index 353e568054b..3cac1d90071 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.choropleth.unselected.Marker + - An instance of :class:`plotly.graph_objs.choropleth.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -43,8 +43,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.choropleth.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.unselected.Mark + er` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -55,10 +55,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Unselected + an instance of + :class:`plotly.graph_objs.choropleth.Unselected` marker - plotly.graph_objects.choropleth.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.unselected.Mark + er` instance or dict with compatible properties Returns ------- @@ -79,7 +80,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.Unselected constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Unselected""" +an instance of :class:`plotly.graph_objs.choropleth.Unselected`""" ) # Handle skip_invalid @@ -187,7 +188,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Stream + an instance of + :class:`plotly.graph_objs.choropleth.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -217,7 +219,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.Stream constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Stream""" +an instance of :class:`plotly.graph_objs.choropleth.Stream`""" ) # Handle skip_invalid @@ -262,7 +264,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.choropleth.selected.Marker + - An instance of :class:`plotly.graph_objs.choropleth.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -293,8 +295,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.choropleth.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.selected.Marker + ` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -305,10 +307,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Selected + an instance of + :class:`plotly.graph_objs.choropleth.Selected` marker - plotly.graph_objects.choropleth.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.selected.Marker + ` instance or dict with compatible properties Returns ------- @@ -329,7 +332,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.Selected constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Selected""" +an instance of :class:`plotly.graph_objs.choropleth.Selected`""" ) # Handle skip_invalid @@ -371,7 +374,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.choropleth.marker.Line + - An instance of :class:`plotly.graph_objs.choropleth.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -457,8 +460,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ line - plotly.graph_objects.choropleth.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the locations. opacitysrc @@ -473,10 +476,11 @@ def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs) ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Marker + an instance of + :class:`plotly.graph_objs.choropleth.Marker` line - plotly.graph_objects.choropleth.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.choropleth.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the locations. opacitysrc @@ -501,7 +505,7 @@ def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs) """\ The first argument to the plotly.graph_objs.choropleth.Marker constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Marker""" +an instance of :class:`plotly.graph_objs.choropleth.Marker`""" ) # Handle skip_invalid @@ -755,7 +759,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.choropleth.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.choropleth.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -910,7 +914,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Hoverlabel + an instance of + :class:`plotly.graph_objs.choropleth.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -959,7 +964,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choropleth.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Hoverlabel""" +an instance of :class:`plotly.graph_objs.choropleth.Hoverlabel`""" ) # Handle skip_invalid @@ -1639,7 +1644,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.choropleth.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1772,7 +1777,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.choropleth.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2010,7 +2015,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.choropleth.colorbar.Title + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2053,7 +2058,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.choropleth.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2362,9 +2367,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.choropleth.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.choropleth.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.chorop leth.colorbar.tickformatstopdefaults), sets the default @@ -2404,8 +2409,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.choropleth.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.choropleth.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use choropleth.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2499,7 +2504,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.ColorBar + an instance of + :class:`plotly.graph_objs.choropleth.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2612,9 +2618,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.choropleth.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.choropleth.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.chorop leth.colorbar.tickformatstopdefaults), sets the default @@ -2654,8 +2660,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.choropleth.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.choropleth.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use choropleth.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2707,7 +2713,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choropleth.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.choropleth.ColorBar""" +an instance of :class:`plotly.graph_objs.choropleth.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/__init__.py index 43447436820..8df54c4df76 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.choropleth.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choropleth.colorbar.Title + :class:`plotly.graph_objs.choropleth.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.Title""" +an instance of :class:`plotly.graph_objs.choropleth.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.choropleth.col + orbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choropleth.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -644,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choropleth.colorbar.Tickfont + :class:`plotly.graph_objs.choropleth.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/__init__.py index 67597ff6fb0..c81fa7577a2 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.colorbar.title.Font + an instance of :class:`plotly.graph_objs.choropleth.col + orbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.choropleth.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/__init__.py index 8a53bf170b7..0d61fa5ce5f 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choropleth.hoverlabel.Font + :class:`plotly.graph_objs.choropleth.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choropleth.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.choropleth.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.choropleth.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/marker/__init__.py index d5d039cd429..4a0f8ee6a1d 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/marker/__init__.py @@ -164,7 +164,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.marker.Line + an instance of + :class:`plotly.graph_objs.choropleth.marker.Line` color Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the @@ -198,7 +199,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choropleth.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.choropleth.marker.Line""" +an instance of :class:`plotly.graph_objs.choropleth.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/selected/__init__.py index 2de704681de..48469be2d46 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/selected/__init__.py @@ -48,7 +48,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choropleth.selected.Marker + :class:`plotly.graph_objs.choropleth.selected.Marker` opacity Sets the marker opacity of selected points. @@ -71,7 +71,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.choropleth.selected.Marker""" +an instance of :class:`plotly.graph_objs.choropleth.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/choropleth/unselected/__init__.py index da2dfff1638..c693e62abdf 100644 --- a/packages/python/plotly/plotly/graph_objs/choropleth/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choropleth/unselected/__init__.py @@ -50,7 +50,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choropleth.unselected.Marker + :class:`plotly.graph_objs.choropleth.unselected.Marker` opacity Sets the marker opacity of unselected points, applied only when a selection exists. @@ -74,7 +74,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.choropleth.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.choropleth.unselected.Marker""" +an instance of :class:`plotly.graph_objs.choropleth.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/__init__.py index 77ce7ed26ed..4f5a6553742 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.unselected.Marker + - An instance of :class:`plotly.graph_objs.choroplethmapbox.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -43,8 +43,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.choroplethmapbox.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.unselecte + d.Marker` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -56,10 +56,10 @@ def __init__(self, arg=None, marker=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.Unselected + :class:`plotly.graph_objs.choroplethmapbox.Unselected` marker - plotly.graph_objects.choroplethmapbox.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.unselecte + d.Marker` instance or dict with compatible properties Returns ------- @@ -80,7 +80,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.Unselected constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.Unselected""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected`""" ) # Handle skip_invalid @@ -189,7 +189,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.Stream + :class:`plotly.graph_objs.choroplethmapbox.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -219,7 +219,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.Stream constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.Stream""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.Stream`""" ) # Handle skip_invalid @@ -264,7 +264,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.selected.Marker + - An instance of :class:`plotly.graph_objs.choroplethmapbox.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -295,8 +295,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.choroplethmapbox.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.selected. + Marker` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -308,10 +308,10 @@ def __init__(self, arg=None, marker=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.Selected + :class:`plotly.graph_objs.choroplethmapbox.Selected` marker - plotly.graph_objects.choroplethmapbox.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.selected. + Marker` instance or dict with compatible properties Returns ------- @@ -332,7 +332,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.Selected constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.Selected""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.Selected`""" ) # Handle skip_invalid @@ -374,7 +374,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.marker.Line + - An instance of :class:`plotly.graph_objs.choroplethmapbox.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -460,8 +460,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ line - plotly.graph_objects.choroplethmapbox.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.marker.Li + ne` instance or dict with compatible properties opacity Sets the opacity of the locations. opacitysrc @@ -477,10 +477,10 @@ def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs) arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.Marker + :class:`plotly.graph_objs.choroplethmapbox.Marker` line - plotly.graph_objects.choroplethmapbox.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.marker.Li + ne` instance or dict with compatible properties opacity Sets the opacity of the locations. opacitysrc @@ -505,7 +505,7 @@ def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs) """\ The first argument to the plotly.graph_objs.choroplethmapbox.Marker constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.Marker""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.Marker`""" ) # Handle skip_invalid @@ -759,7 +759,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.choroplethmapbox.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -915,7 +915,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.Hoverlabel + :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -964,7 +964,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choroplethmapbox.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.Hoverlabel""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel`""" ) # Handle skip_invalid @@ -1644,7 +1644,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1778,7 +1778,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2016,7 +2016,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.colorbar.Title + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2060,7 +2060,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2369,9 +2369,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.choroplethmapbox.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.choroplethmapbo + x.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.chorop lethmapbox.colorbar.tickformatstopdefaults), sets the @@ -2411,8 +2411,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.choroplethmapbox.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use choroplethmapbox.colorbar.title.font instead. Sets this @@ -2508,7 +2508,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.ColorBar + :class:`plotly.graph_objs.choroplethmapbox.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2621,9 +2621,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.choroplethmapbox.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.choroplethmapbo + x.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.chorop lethmapbox.colorbar.tickformatstopdefaults), sets the @@ -2663,8 +2663,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.choroplethmapbox.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use choroplethmapbox.colorbar.title.font instead. Sets this @@ -2717,7 +2717,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choroplethmapbox.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.ColorBar""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py index 95c4dfbe3f4..a582175c625 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.choroplethmapbox.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choroplethmapbox.colorbar.Title + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.colorbar.Title""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choroplethmapbox.color - bar.Tickformatstop + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choroplethmapbox.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py index f828699b73e..f7fae0f85d8 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choroplethmapbox.colorbar.title.Font + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py index 465570c60b1..8486f34a4af 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choroplethmapbox.hoverlabel.Font + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choroplethmapbox.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/__init__.py index 327b25b5c73..b49cc175c40 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/__init__.py @@ -165,7 +165,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.choroplethmapbox.marker.Line + :class:`plotly.graph_objs.choroplethmapbox.marker.Line` color Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the @@ -199,7 +199,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.choroplethmapbox.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.marker.Line""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/__init__.py index 0ab54352f71..9d6e24e216d 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/__init__.py @@ -47,8 +47,8 @@ def __init__(self, arg=None, opacity=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choroplethmapbox.selected.Marker + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.selected.Marker` opacity Sets the marker opacity of selected points. @@ -71,7 +71,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.selected.Marker""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/__init__.py index 2230b6e0eb5..da3aace0658 100644 --- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/__init__.py @@ -49,8 +49,8 @@ def __init__(self, arg=None, opacity=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choroplethmapbox.unselected.Marker + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.unselected.Marker` opacity Sets the marker opacity of unselected points, applied only when a selection exists. @@ -74,7 +74,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.choroplethmapbox.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.choroplethmapbox.unselected.Marker""" +an instance of :class:`plotly.graph_objs.choroplethmapbox.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/cone/__init__.py b/packages/python/plotly/plotly/graph_objs/cone/__init__.py index a151d9937f6..ff4f5e2bdbe 100644 --- a/packages/python/plotly/plotly/graph_objs/cone/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/cone/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Stream + an instance of :class:`plotly.graph_objs.cone.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.cone.Stream constructor must be a dict or -an instance of plotly.graph_objs.cone.Stream""" +an instance of :class:`plotly.graph_objs.cone.Stream`""" ) # Handle skip_invalid @@ -235,7 +235,8 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Lightposition + an instance of + :class:`plotly.graph_objs.cone.Lightposition` x Numeric vector, representing the X coordinate for each vertex. @@ -265,7 +266,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.cone.Lightposition constructor must be a dict or -an instance of plotly.graph_objs.cone.Lightposition""" +an instance of :class:`plotly.graph_objs.cone.Lightposition`""" ) # Handle skip_invalid @@ -509,7 +510,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Lighting + an instance of :class:`plotly.graph_objs.cone.Lighting` ambient Ambient light increases overall color visibility but can wash out the image. @@ -553,7 +554,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.cone.Lighting constructor must be a dict or -an instance of plotly.graph_objs.cone.Lighting""" +an instance of :class:`plotly.graph_objs.cone.Lighting`""" ) # Handle skip_invalid @@ -827,7 +828,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.cone.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.cone.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -982,7 +983,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Hoverlabel + an instance of + :class:`plotly.graph_objs.cone.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1031,7 +1033,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.cone.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.cone.Hoverlabel""" +an instance of :class:`plotly.graph_objs.cone.Hoverlabel`""" ) # Handle skip_invalid @@ -1711,7 +1713,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.cone.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.cone.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1845,7 +1847,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.cone.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.cone.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2083,7 +2085,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.cone.colorbar.Title + - An instance of :class:`plotly.graph_objs.cone.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2126,7 +2128,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.cone.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.cone.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2435,9 +2437,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.cone.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.cone.colorbar.T + ickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.cone.c olorbar.tickformatstopdefaults), sets the default @@ -2477,8 +2479,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.cone.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.cone.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use cone.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2572,7 +2574,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.ColorBar + an instance of :class:`plotly.graph_objs.cone.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2685,9 +2687,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.cone.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.cone.colorbar.T + ickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.cone.c olorbar.tickformatstopdefaults), sets the default @@ -2727,8 +2729,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.cone.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.cone.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use cone.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2780,7 +2782,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.cone.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.cone.ColorBar""" +an instance of :class:`plotly.graph_objs.cone.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/cone/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/cone/colorbar/__init__.py index dddf6e448cc..a8dbb02c170 100644 --- a/packages/python/plotly/plotly/graph_objs/cone/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/cone/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.cone.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.cone.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,7 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.colorbar.Title + an instance of + :class:`plotly.graph_objs.cone.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -166,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.cone.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.Title""" +an instance of :class:`plotly.graph_objs.cone.colorbar.Title`""" ) # Handle skip_invalid @@ -391,7 +392,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.cone.colorbar.Tickformatstop + :class:`plotly.graph_objs.cone.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -442,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.cone.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.cone.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -640,7 +641,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.colorbar.Tickfont + an instance of + :class:`plotly.graph_objs.cone.colorbar.Tickfont` color family @@ -679,7 +681,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.cone.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.cone.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/__init__.py index e3c7ca50592..b808abf1a29 100644 --- a/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.cone.colorbar.title.Font + :class:`plotly.graph_objs.cone.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.cone.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.cone.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/__init__.py index 6848854f747..9b5adc775c7 100644 --- a/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.cone.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.cone.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.cone.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.cone.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contour/__init__.py b/packages/python/plotly/plotly/graph_objs/contour/__init__.py index 660ad4afd70..61daa234bd4 100644 --- a/packages/python/plotly/plotly/graph_objs/contour/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contour/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Stream + an instance of + :class:`plotly.graph_objs.contour.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.contour.Stream constructor must be a dict or -an instance of plotly.graph_objs.contour.Stream""" +an instance of :class:`plotly.graph_objs.contour.Stream`""" ) # Handle skip_invalid @@ -312,7 +313,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Line + an instance of :class:`plotly.graph_objs.contour.Line` color Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines". @@ -348,7 +349,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contour.Line constructor must be a dict or -an instance of plotly.graph_objs.contour.Line""" +an instance of :class:`plotly.graph_objs.contour.Line`""" ) # Handle skip_invalid @@ -605,7 +606,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.contour.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.contour.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -760,7 +761,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Hoverlabel + an instance of + :class:`plotly.graph_objs.contour.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -809,7 +811,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contour.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.contour.Hoverlabel""" +an instance of :class:`plotly.graph_objs.contour.Hoverlabel`""" ) # Handle skip_invalid @@ -925,7 +927,7 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of plotly.graph_objs.contour.contours.Labelfont + - An instance of :class:`plotly.graph_objs.contour.contours.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor @@ -1237,7 +1239,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Contours + an instance of + :class:`plotly.graph_objs.contour.Contours` coloring Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each @@ -1313,7 +1316,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contour.Contours constructor must be a dict or -an instance of plotly.graph_objs.contour.Contours""" +an instance of :class:`plotly.graph_objs.contour.Contours`""" ) # Handle skip_invalid @@ -1999,7 +2002,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.contour.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.contour.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2133,7 +2136,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.contour.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.contour.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2371,7 +2374,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.contour.colorbar.Title + - An instance of :class:`plotly.graph_objs.contour.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2414,7 +2417,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.contour.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.contour.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2723,9 +2726,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.contour.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.contour.colorba + r.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.contou r.colorbar.tickformatstopdefaults), sets the default @@ -2765,8 +2768,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.contour.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use contour.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2860,7 +2863,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.ColorBar + an instance of + :class:`plotly.graph_objs.contour.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2973,9 +2977,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.contour.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.contour.colorba + r.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.contou r.colorbar.tickformatstopdefaults), sets the default @@ -3015,8 +3019,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.contour.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use contour.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -3068,7 +3072,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contour.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.contour.ColorBar""" +an instance of :class:`plotly.graph_objs.contour.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contour/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/contour/colorbar/__init__.py index 0c6209571a4..bb211f94cbb 100644 --- a/packages/python/plotly/plotly/graph_objs/contour/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contour/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.contour.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.contour.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,7 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.colorbar.Title + an instance of + :class:`plotly.graph_objs.contour.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -166,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.contour.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.Title""" +an instance of :class:`plotly.graph_objs.contour.colorbar.Title`""" ) # Handle skip_invalid @@ -390,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contour.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.contour.colorb + ar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -442,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contour.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.contour.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.contour.colorbar.Tickfont + :class:`plotly.graph_objs.contour.colorbar.Tickfont` color family @@ -682,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.contour.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.contour.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/__init__.py index 8f90e3a5dcb..e8c89d321db 100644 --- a/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.contour.colorbar.title.Font + :class:`plotly.graph_objs.contour.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.contour.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.contour.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contour/contours/__init__.py b/packages/python/plotly/plotly/graph_objs/contour/contours/__init__.py index 467a82842cf..d21cb59d874 100644 --- a/packages/python/plotly/plotly/graph_objs/contour/contours/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contour/contours/__init__.py @@ -154,7 +154,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.contour.contours.Labelfont + :class:`plotly.graph_objs.contour.contours.Labelfont` color family @@ -193,7 +193,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.contour.contours.Labelfont constructor must be a dict or -an instance of plotly.graph_objs.contour.contours.Labelfont""" +an instance of :class:`plotly.graph_objs.contour.contours.Labelfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/__init__.py index 55bb306ee7f..d043328b0c3 100644 --- a/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.contour.hoverlabel.Font + :class:`plotly.graph_objs.contour.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contour.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.contour.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.contour.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/__init__.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/__init__.py index c3322a923ec..9e2715f4c42 100644 --- a/packages/python/plotly/plotly/graph_objs/contourcarpet/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.Stream + an instance of + :class:`plotly.graph_objs.contourcarpet.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.contourcarpet.Stream constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Stream""" +an instance of :class:`plotly.graph_objs.contourcarpet.Stream`""" ) # Handle skip_invalid @@ -312,7 +313,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.Line + an instance of + :class:`plotly.graph_objs.contourcarpet.Line` color Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines". @@ -348,7 +350,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contourcarpet.Line constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Line""" +an instance of :class:`plotly.graph_objs.contourcarpet.Line`""" ) # Handle skip_invalid @@ -448,7 +450,7 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.contours.Labelfont + - An instance of :class:`plotly.graph_objs.contourcarpet.contours.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor @@ -759,7 +761,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.Contours + an instance of + :class:`plotly.graph_objs.contourcarpet.Contours` coloring Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each @@ -834,7 +837,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contourcarpet.Contours constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Contours""" +an instance of :class:`plotly.graph_objs.contourcarpet.Contours`""" ) # Handle skip_invalid @@ -1520,7 +1523,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1654,7 +1657,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1892,7 +1895,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.colorbar.Title + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1936,7 +1939,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2245,9 +2248,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.contourcarpet.colorbar. - Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.contourcarpet.c + olorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.contou rcarpet.colorbar.tickformatstopdefaults), sets the @@ -2287,8 +2290,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.contourcarpet.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.colorbar.Tit + le` instance or dict with compatible properties titlefont Deprecated: Please use contourcarpet.colorbar.title.font instead. Sets this @@ -2382,7 +2385,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.ColorBar + an instance of + :class:`plotly.graph_objs.contourcarpet.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2495,9 +2499,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.contourcarpet.colorbar. - Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.contourcarpet.c + olorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.contou rcarpet.colorbar.tickformatstopdefaults), sets the @@ -2537,8 +2541,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.contourcarpet.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.colorbar.Tit + le` instance or dict with compatible properties titlefont Deprecated: Please use contourcarpet.colorbar.title.font instead. Sets this @@ -2590,7 +2594,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contourcarpet.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.ColorBar""" +an instance of :class:`plotly.graph_objs.contourcarpet.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/__init__.py index 139e9327603..03ffb9b9935 100644 --- a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.contourcarpet.colorbar.Title + :class:`plotly.graph_objs.contourcarpet.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.contourcarpet.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.Title""" +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.contourcarpet. + colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.contourcarpet. + colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py index 94a7d9b36d4..b969db0e212 100644 --- a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.title.Font + an instance of :class:`plotly.graph_objs.contourcarpet. + colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.contourcarpet.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/__init__.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/__init__.py index 329e914ab97..3722db0b2b5 100644 --- a/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/__init__.py @@ -153,8 +153,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.contours.Labelfont + an instance of :class:`plotly.graph_objs.contourcarpet. + contours.Labelfont` color family @@ -193,7 +193,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.contourcarpet.contours.Labelfont constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.contours.Labelfont""" +an instance of :class:`plotly.graph_objs.contourcarpet.contours.Labelfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/__init__.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/__init__.py index dcc52c959aa..e4035ac0d20 100644 --- a/packages/python/plotly/plotly/graph_objs/densitymapbox/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.densitymapbox.Stream + an instance of + :class:`plotly.graph_objs.densitymapbox.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.densitymapbox.Stream constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.Stream""" +an instance of :class:`plotly.graph_objs.densitymapbox.Stream`""" ) # Handle skip_invalid @@ -358,7 +359,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.densitymapbox.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -514,7 +515,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.densitymapbox.Hoverlabel + :class:`plotly.graph_objs.densitymapbox.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -563,7 +564,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.densitymapbox.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.Hoverlabel""" +an instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel`""" ) # Handle skip_invalid @@ -1243,7 +1244,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1377,7 +1378,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1615,7 +1616,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.colorbar.Title + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1659,7 +1660,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1968,9 +1969,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.densitymapbox.colorbar. - Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.densitymapbox.c + olorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.densit ymapbox.colorbar.tickformatstopdefaults), sets the @@ -2010,8 +2011,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.densitymapbox.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.colorbar.Tit + le` instance or dict with compatible properties titlefont Deprecated: Please use densitymapbox.colorbar.title.font instead. Sets this @@ -2105,7 +2106,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.densitymapbox.ColorBar + an instance of + :class:`plotly.graph_objs.densitymapbox.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2218,9 +2220,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.densitymapbox.colorbar. - Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.densitymapbox.c + olorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.densit ymapbox.colorbar.tickformatstopdefaults), sets the @@ -2260,8 +2262,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.densitymapbox.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.colorbar.Tit + le` instance or dict with compatible properties titlefont Deprecated: Please use densitymapbox.colorbar.title.font instead. Sets this @@ -2313,7 +2315,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.densitymapbox.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.ColorBar""" +an instance of :class:`plotly.graph_objs.densitymapbox.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/__init__.py index 1c267f72cf4..0ea820b0ac3 100644 --- a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.densitymapbox.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.densitymapbox.colorbar.Title + :class:`plotly.graph_objs.densitymapbox.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.densitymapbox.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.colorbar.Title""" +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.densitymapbox.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.densitymapbox. + colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.densitymapbox.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.densitymapbox.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.densitymapbox. + colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.densitymapbox.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py index bdb50d263c6..a63f5070ea0 100644 --- a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.densitymapbox.colorbar.title.Font + an instance of :class:`plotly.graph_objs.densitymapbox. + colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.densitymapbox.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py index 51a830ab96e..c29ee0560a8 100644 --- a/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.densitymapbox.hoverlabel.Font + an instance of :class:`plotly.graph_objs.densitymapbox. + hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.densitymapbox.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.densitymapbox.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.densitymapbox.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnel/__init__.py b/packages/python/plotly/plotly/graph_objs/funnel/__init__.py index ed2e1dc2c6f..a9f32e3e4a0 100644 --- a/packages/python/plotly/plotly/graph_objs/funnel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Textfont + an instance of + :class:`plotly.graph_objs.funnel.Textfont` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.Textfont constructor must be a dict or -an instance of plotly.graph_objs.funnel.Textfont""" +an instance of :class:`plotly.graph_objs.funnel.Textfont`""" ) # Handle skip_invalid @@ -398,7 +399,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Stream + an instance of :class:`plotly.graph_objs.funnel.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -428,7 +429,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnel.Stream constructor must be a dict or -an instance of plotly.graph_objs.funnel.Stream""" +an instance of :class:`plotly.graph_objs.funnel.Stream`""" ) # Handle skip_invalid @@ -692,7 +693,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Outsidetextfont + an instance of + :class:`plotly.graph_objs.funnel.Outsidetextfont` color colorsrc @@ -737,7 +739,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.Outsidetextfont constructor must be a dict or -an instance of plotly.graph_objs.funnel.Outsidetextfont""" +an instance of :class:`plotly.graph_objs.funnel.Outsidetextfont`""" ) # Handle skip_invalid @@ -1007,7 +1009,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.ColorBar + - An instance of :class:`plotly.graph_objs.funnel.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1139,9 +1141,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.funnel.marker.c - olorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.funnel. + marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.funnel.marker.colorbar.tickformatstopdefaults @@ -1188,8 +1190,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.funnel.marker.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.colo + rbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use funnel.marker.colorbar.title.font instead. Sets @@ -1315,7 +1318,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.Line + - An instance of :class:`plotly.graph_objs.funnel.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1564,8 +1567,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.funnel.marker.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1583,8 +1586,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.funnel.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1628,7 +1631,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Marker + an instance of :class:`plotly.graph_objs.funnel.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1676,8 +1679,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.funnel.marker.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1695,8 +1698,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.funnel.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1731,7 +1734,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.Marker constructor must be a dict or -an instance of plotly.graph_objs.funnel.Marker""" +an instance of :class:`plotly.graph_objs.funnel.Marker`""" ) # Handle skip_invalid @@ -2034,7 +2037,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Insidetextfont + an instance of + :class:`plotly.graph_objs.funnel.Insidetextfont` color colorsrc @@ -2079,7 +2083,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.funnel.Insidetextfont""" +an instance of :class:`plotly.graph_objs.funnel.Insidetextfont`""" ) # Handle skip_invalid @@ -2342,7 +2346,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.funnel.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.funnel.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2497,7 +2501,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Hoverlabel + an instance of + :class:`plotly.graph_objs.funnel.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2546,7 +2551,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.funnel.Hoverlabel""" +an instance of :class:`plotly.graph_objs.funnel.Hoverlabel`""" ) # Handle skip_invalid @@ -2671,7 +2676,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.funnel.connector.Line + - An instance of :class:`plotly.graph_objs.funnel.connector.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -2731,8 +2736,8 @@ def _prop_descriptions(self): fillcolor Sets the fill color. line - plotly.graph_objects.funnel.connector.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.connector.Line` + instance or dict with compatible properties visible Determines if connector regions and lines are drawn. """ @@ -2745,12 +2750,13 @@ def __init__(self, arg=None, fillcolor=None, line=None, visible=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.Connector + an instance of + :class:`plotly.graph_objs.funnel.Connector` fillcolor Sets the fill color. line - plotly.graph_objects.funnel.connector.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.connector.Line` + instance or dict with compatible properties visible Determines if connector regions and lines are drawn. @@ -2773,7 +2779,7 @@ def __init__(self, arg=None, fillcolor=None, line=None, visible=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnel.Connector constructor must be a dict or -an instance of plotly.graph_objs.funnel.Connector""" +an instance of :class:`plotly.graph_objs.funnel.Connector`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnel/connector/__init__.py b/packages/python/plotly/plotly/graph_objs/funnel/connector/__init__.py index dfce3d3242e..820eb711998 100644 --- a/packages/python/plotly/plotly/graph_objs/funnel/connector/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnel/connector/__init__.py @@ -139,7 +139,8 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.connector.Line + an instance of + :class:`plotly.graph_objs.funnel.connector.Line` color Sets the line color. dash @@ -169,7 +170,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnel.connector.Line constructor must be a dict or -an instance of plotly.graph_objs.funnel.connector.Line""" +an instance of :class:`plotly.graph_objs.funnel.connector.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/__init__.py index 4f3f9dfca83..08485d502e5 100644 --- a/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.funnel.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.funnel.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.funnel.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/__init__.py index 5fe7171aaed..30adee20b45 100644 --- a/packages/python/plotly/plotly/graph_objs/funnel/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.marker.Line + an instance of + :class:`plotly.graph_objs.funnel.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.funnel.marker.Line""" +an instance of :class:`plotly.graph_objs.funnel.marker.Line`""" ) # Handle skip_invalid @@ -1258,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1392,7 +1393,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1630,7 +1631,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1674,7 +1675,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1983,9 +1984,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.funnel.marker.colorbar. - Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.funnel.marker.c + olorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.funnel .marker.colorbar.tickformatstopdefaults), sets the @@ -2025,8 +2026,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.funnel.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.colorbar.Tit + le` instance or dict with compatible properties titlefont Deprecated: Please use funnel.marker.colorbar.title.font instead. Sets this @@ -2120,7 +2121,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnel.marker.ColorBar + an instance of + :class:`plotly.graph_objs.funnel.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2233,9 +2235,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.funnel.marker.colorbar. - Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.funnel.marker.c + olorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.funnel .marker.colorbar.tickformatstopdefaults), sets the @@ -2275,8 +2277,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.funnel.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.colorbar.Tit + le` instance or dict with compatible properties titlefont Deprecated: Please use funnel.marker.colorbar.title.font instead. Sets this @@ -2328,7 +2330,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.funnel.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.funnel.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/__init__.py index a50c0b96e7a..e1a06ad0d8b 100644 --- a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.funnel.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.funnel.marker.colorbar.Title + :class:`plotly.graph_objs.funnel.marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnel.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.funnel.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.funnel.marker.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.funnel.marker. + colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnel.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.funnel.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.funnel.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.funnel.marker. + colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnel.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.funnel.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py index e7f9177983a..c58322dfafd 100644 --- a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.funnel.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.funnel.marker. + colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnel.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.funnel.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/__init__.py b/packages/python/plotly/plotly/graph_objs/funnelarea/__init__.py index 049f2a912e2..1184f1a1b0a 100644 --- a/packages/python/plotly/plotly/graph_objs/funnelarea/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnelarea/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.funnelarea.title.Font + - An instance of :class:`plotly.graph_objs.funnelarea.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -142,7 +142,8 @@ def __init__(self, arg=None, font=None, position=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.Title + an instance of + :class:`plotly.graph_objs.funnelarea.Title` font Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` @@ -177,7 +178,7 @@ def __init__(self, arg=None, font=None, position=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnelarea.Title constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Title""" +an instance of :class:`plotly.graph_objs.funnelarea.Title`""" ) # Handle skip_invalid @@ -444,7 +445,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.Textfont + an instance of + :class:`plotly.graph_objs.funnelarea.Textfont` color colorsrc @@ -489,7 +491,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnelarea.Textfont constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Textfont""" +an instance of :class:`plotly.graph_objs.funnelarea.Textfont`""" ) # Handle skip_invalid @@ -612,7 +614,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.Stream + an instance of + :class:`plotly.graph_objs.funnelarea.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -642,7 +645,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnelarea.Stream constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Stream""" +an instance of :class:`plotly.graph_objs.funnelarea.Stream`""" ) # Handle skip_invalid @@ -728,7 +731,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.funnelarea.marker.Line + - An instance of :class:`plotly.graph_objs.funnelarea.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -775,8 +778,8 @@ def _prop_descriptions(self): colorssrc Sets the source reference on plot.ly for colors . line - plotly.graph_objects.funnelarea.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.funnelarea.marker.Line` + instance or dict with compatible properties """ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): @@ -787,7 +790,8 @@ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.Marker + an instance of + :class:`plotly.graph_objs.funnelarea.Marker` colors Sets the color of each sector. If not specified, the default trace color set is used to pick the sector @@ -795,8 +799,8 @@ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): colorssrc Sets the source reference on plot.ly for colors . line - plotly.graph_objects.funnelarea.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.funnelarea.marker.Line` + instance or dict with compatible properties Returns ------- @@ -817,7 +821,7 @@ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnelarea.Marker constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Marker""" +an instance of :class:`plotly.graph_objs.funnelarea.Marker`""" ) # Handle skip_invalid @@ -1085,7 +1089,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.funnelarea.Insidetextfont + :class:`plotly.graph_objs.funnelarea.Insidetextfont` color colorsrc @@ -1130,7 +1134,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnelarea.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Insidetextfont""" +an instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont`""" ) # Handle skip_invalid @@ -1393,7 +1397,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.funnelarea.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.funnelarea.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1548,7 +1552,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.Hoverlabel + an instance of + :class:`plotly.graph_objs.funnelarea.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1597,7 +1602,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnelarea.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Hoverlabel""" +an instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel`""" ) # Handle skip_invalid @@ -1785,7 +1790,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.Domain + an instance of + :class:`plotly.graph_objs.funnelarea.Domain` column If there is a layout grid, use the domain for this column in the grid for this funnelarea trace . @@ -1818,7 +1824,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.funnelarea.Domain constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.Domain""" +an instance of :class:`plotly.graph_objs.funnelarea.Domain`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/__init__.py index 9fc09f70136..4e4c5a2d18c 100644 --- a/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.funnelarea.hoverlabel.Font + :class:`plotly.graph_objs.funnelarea.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnelarea.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.funnelarea.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/funnelarea/marker/__init__.py index 26b07bdad49..32a5c03e20d 100644 --- a/packages/python/plotly/plotly/graph_objs/funnelarea/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnelarea/marker/__init__.py @@ -159,7 +159,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.marker.Line + an instance of + :class:`plotly.graph_objs.funnelarea.marker.Line` color Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value. @@ -190,7 +191,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnelarea.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.marker.Line""" +an instance of :class:`plotly.graph_objs.funnelarea.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/title/__init__.py b/packages/python/plotly/plotly/graph_objs/funnelarea/title/__init__.py index 6fc05eac95f..e506c35dafe 100644 --- a/packages/python/plotly/plotly/graph_objs/funnelarea/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/funnelarea/title/__init__.py @@ -231,7 +231,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.funnelarea.title.Font + an instance of + :class:`plotly.graph_objs.funnelarea.title.Font` color colorsrc @@ -276,7 +277,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.funnelarea.title.Font constructor must be a dict or -an instance of plotly.graph_objs.funnelarea.title.Font""" +an instance of :class:`plotly.graph_objs.funnelarea.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmap/__init__.py index 9247ce05184..9fc461c13b5 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmap/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmap/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.Stream + an instance of + :class:`plotly.graph_objs.heatmap.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmap.Stream constructor must be a dict or -an instance of plotly.graph_objs.heatmap.Stream""" +an instance of :class:`plotly.graph_objs.heatmap.Stream`""" ) # Handle skip_invalid @@ -358,7 +359,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.heatmap.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.heatmap.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -513,7 +514,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.Hoverlabel + an instance of + :class:`plotly.graph_objs.heatmap.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -562,7 +564,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmap.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.heatmap.Hoverlabel""" +an instance of :class:`plotly.graph_objs.heatmap.Hoverlabel`""" ) # Handle skip_invalid @@ -1242,7 +1244,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.heatmap.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1376,7 +1378,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.heatmap.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1614,7 +1616,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.heatmap.colorbar.Title + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1657,7 +1659,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.heatmap.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1966,9 +1968,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.heatmap.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.heatmap.colorba + r.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.heatma p.colorbar.tickformatstopdefaults), sets the default @@ -2008,8 +2010,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmap.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use heatmap.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2103,7 +2105,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.ColorBar + an instance of + :class:`plotly.graph_objs.heatmap.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2216,9 +2219,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.heatmap.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.heatmap.colorba + r.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.heatma p.colorbar.tickformatstopdefaults), sets the default @@ -2258,8 +2261,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmap.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use heatmap.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2311,7 +2314,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmap.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.heatmap.ColorBar""" +an instance of :class:`plotly.graph_objs.heatmap.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/__init__.py index b881b8c8f36..59aac172f4f 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.heatmap.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,7 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.colorbar.Title + an instance of + :class:`plotly.graph_objs.heatmap.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -166,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmap.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.Title""" +an instance of :class:`plotly.graph_objs.heatmap.colorbar.Title`""" ) # Handle skip_invalid @@ -390,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmap.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.heatmap.colorb + ar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -442,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmap.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.heatmap.colorbar.Tickfont + :class:`plotly.graph_objs.heatmap.colorbar.Tickfont` color family @@ -682,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmap.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/__init__.py index f5bd44e15d8..9a42d3a9786 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.heatmap.colorbar.title.Font + :class:`plotly.graph_objs.heatmap.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmap.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.heatmap.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/__init__.py index 58a5e8b9973..39ed69ebc33 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.heatmap.hoverlabel.Font + :class:`plotly.graph_objs.heatmap.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmap.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.heatmap.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.heatmap.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/__init__.py index 5be9858011d..395dfee7f7d 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmapgl/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmapgl.Stream + an instance of + :class:`plotly.graph_objs.heatmapgl.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmapgl.Stream constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.Stream""" +an instance of :class:`plotly.graph_objs.heatmapgl.Stream`""" ) # Handle skip_invalid @@ -358,7 +359,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.heatmapgl.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -513,7 +514,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmapgl.Hoverlabel + an instance of + :class:`plotly.graph_objs.heatmapgl.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -562,7 +564,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmapgl.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.Hoverlabel""" +an instance of :class:`plotly.graph_objs.heatmapgl.Hoverlabel`""" ) # Handle skip_invalid @@ -1242,7 +1244,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1375,7 +1377,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1613,7 +1615,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.colorbar.Title + - An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1656,7 +1658,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1965,9 +1967,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.heatmapgl.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.heatmapgl.color + bar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.heatma pgl.colorbar.tickformatstopdefaults), sets the default @@ -2007,8 +2009,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmapgl.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use heatmapgl.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2102,7 +2104,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmapgl.ColorBar + an instance of + :class:`plotly.graph_objs.heatmapgl.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2215,9 +2218,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.heatmapgl.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.heatmapgl.color + bar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.heatma pgl.colorbar.tickformatstopdefaults), sets the default @@ -2257,8 +2260,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmapgl.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use heatmapgl.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2310,7 +2313,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmapgl.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.ColorBar""" +an instance of :class:`plotly.graph_objs.heatmapgl.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/__init__.py index 6d722689bbe..d2b7994c01a 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.heatmapgl.colorbar.Title + :class:`plotly.graph_objs.heatmapgl.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmapgl.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.Title""" +an instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.heatmapgl.colo + rbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmapgl.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -644,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.heatmapgl.colorbar.Tickfont + :class:`plotly.graph_objs.heatmapgl.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmapgl.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py index 12359bbb928..a6a0f0308e2 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.colorbar.title.Font + an instance of :class:`plotly.graph_objs.heatmapgl.colo + rbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.heatmapgl.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.heatmapgl.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py index 8380a4deaf1..955454b5c7b 100644 --- a/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.heatmapgl.hoverlabel.Font + :class:`plotly.graph_objs.heatmapgl.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.heatmapgl.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.heatmapgl.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/__init__.py index 547c4e99d11..fa33d87f65f 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/__init__.py @@ -147,7 +147,8 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.YBins + an instance of + :class:`plotly.graph_objs.histogram.YBins` end Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin @@ -205,7 +206,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.YBins constructor must be a dict or -an instance of plotly.graph_objs.histogram.YBins""" +an instance of :class:`plotly.graph_objs.histogram.YBins`""" ) # Handle skip_invalid @@ -389,7 +390,8 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.XBins + an instance of + :class:`plotly.graph_objs.histogram.XBins` end Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin @@ -447,7 +449,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.XBins constructor must be a dict or -an instance of plotly.graph_objs.histogram.XBins""" +an instance of :class:`plotly.graph_objs.histogram.XBins`""" ) # Handle skip_invalid @@ -495,7 +497,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.histogram.unselected.Marker + - An instance of :class:`plotly.graph_objs.histogram.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -525,7 +527,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.histogram.unselected.Textfont + - An instance of :class:`plotly.graph_objs.histogram.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -557,11 +559,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.histogram.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselected.Marke + r` instance or dict with compatible properties textfont - plotly.graph_objects.histogram.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselected.Textf + ont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -572,13 +574,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Unselected + an instance of + :class:`plotly.graph_objs.histogram.Unselected` marker - plotly.graph_objects.histogram.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselected.Marke + r` instance or dict with compatible properties textfont - plotly.graph_objects.histogram.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselected.Textf + ont` instance or dict with compatible properties Returns ------- @@ -599,7 +602,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.Unselected constructor must be a dict or -an instance of plotly.graph_objs.histogram.Unselected""" +an instance of :class:`plotly.graph_objs.histogram.Unselected`""" ) # Handle skip_invalid @@ -710,7 +713,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Stream + an instance of + :class:`plotly.graph_objs.histogram.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -740,7 +744,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.Stream constructor must be a dict or -an instance of plotly.graph_objs.histogram.Stream""" +an instance of :class:`plotly.graph_objs.histogram.Stream`""" ) # Handle skip_invalid @@ -785,7 +789,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.histogram.selected.Marker + - An instance of :class:`plotly.graph_objs.histogram.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -813,7 +817,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.histogram.selected.Textfont + - An instance of :class:`plotly.graph_objs.histogram.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -844,11 +848,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.histogram.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.histogram.selected.Textfont + :class:`plotly.graph_objects.histogram.selected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.histogram.selected.Textfon + t` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -859,13 +863,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Selected + an instance of + :class:`plotly.graph_objs.histogram.Selected` marker - plotly.graph_objects.histogram.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.histogram.selected.Textfont + :class:`plotly.graph_objects.histogram.selected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.histogram.selected.Textfon + t` instance or dict with compatible properties Returns ------- @@ -886,7 +891,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.Selected constructor must be a dict or -an instance of plotly.graph_objs.histogram.Selected""" +an instance of :class:`plotly.graph_objs.histogram.Selected`""" ) # Handle skip_invalid @@ -1144,7 +1149,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.ColorBar + - An instance of :class:`plotly.graph_objs.histogram.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1276,9 +1281,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram.marke - r.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.histogr + am.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram.marker.colorbar.tickformatstopdefau @@ -1325,8 +1330,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram.marker.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.histogram.marker.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -1453,7 +1458,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.Line + - An instance of :class:`plotly.graph_objs.histogram.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1702,8 +1707,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1721,8 +1726,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.histogram.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1766,7 +1771,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Marker + an instance of + :class:`plotly.graph_objs.histogram.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1814,8 +1820,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1833,8 +1839,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.histogram.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1869,7 +1875,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.Marker constructor must be a dict or -an instance of plotly.graph_objs.histogram.Marker""" +an instance of :class:`plotly.graph_objs.histogram.Marker`""" ) # Handle skip_invalid @@ -2159,7 +2165,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.histogram.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2314,7 +2320,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Hoverlabel + an instance of + :class:`plotly.graph_objs.histogram.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2363,7 +2370,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.histogram.Hoverlabel""" +an instance of :class:`plotly.graph_objs.histogram.Hoverlabel`""" ) # Handle skip_invalid @@ -2847,7 +2854,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.ErrorY + an instance of + :class:`plotly.graph_objs.histogram.ErrorY` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -2919,7 +2927,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.ErrorY constructor must be a dict or -an instance of plotly.graph_objs.histogram.ErrorY""" +an instance of :class:`plotly.graph_objs.histogram.ErrorY`""" ) # Handle skip_invalid @@ -3439,7 +3447,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.ErrorX + an instance of + :class:`plotly.graph_objs.histogram.ErrorX` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3513,7 +3522,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.ErrorX constructor must be a dict or -an instance of plotly.graph_objs.histogram.ErrorX""" +an instance of :class:`plotly.graph_objs.histogram.ErrorX`""" ) # Handle skip_invalid @@ -3711,7 +3720,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Cumulative + an instance of + :class:`plotly.graph_objs.histogram.Cumulative` currentbin Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its @@ -3754,7 +3764,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.Cumulative constructor must be a dict or -an instance of plotly.graph_objs.histogram.Cumulative""" +an instance of :class:`plotly.graph_objs.histogram.Cumulative`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/__init__.py index b61b1175512..bdce369c22c 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram.hoverlabel.Font + :class:`plotly.graph_objs.histogram.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.histogram.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.histogram.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/__init__.py index be459e05112..3fae928872f 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.marker.Line + an instance of + :class:`plotly.graph_objs.histogram.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.Line""" +an instance of :class:`plotly.graph_objs.histogram.marker.Line`""" ) # Handle skip_invalid @@ -1258,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1392,7 +1393,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1630,7 +1631,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1674,7 +1675,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1983,9 +1984,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram.marker.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.histogram.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.histog ram.marker.colorbar.tickformatstopdefaults), sets the @@ -2025,8 +2026,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use histogram.marker.colorbar.title.font instead. Sets this @@ -2122,7 +2123,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram.marker.ColorBar + :class:`plotly.graph_objs.histogram.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2235,9 +2236,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram.marker.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.histogram.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.histog ram.marker.colorbar.tickformatstopdefaults), sets the @@ -2277,8 +2278,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use histogram.marker.colorbar.title.font instead. Sets this @@ -2331,7 +2332,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.histogram.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/__init__.py index 6e437ac9044..53b1428100d 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.marker.color - bar.Tickformatstop + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py index f9305a21ec9..4a381f93d20 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/selected/__init__.py index e10cf403fad..934fffb0c09 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/selected/__init__.py @@ -87,7 +87,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram.selected.Textfont + :class:`plotly.graph_objs.histogram.selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.histogram.selected.Textfont""" +an instance of :class:`plotly.graph_objs.histogram.selected.Textfont`""" ) # Handle skip_invalid @@ -250,7 +250,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram.selected.Marker + :class:`plotly.graph_objs.histogram.selected.Marker` color Sets the marker color of selected points. opacity @@ -275,7 +275,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.histogram.selected.Marker""" +an instance of :class:`plotly.graph_objs.histogram.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram/unselected/__init__.py index 68235459e28..391fe061e4e 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.unselected.Textfont + an instance of :class:`plotly.graph_objs.histogram.unse + lected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.histogram.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.histogram.unselected.Textfont`""" ) # Handle skip_invalid @@ -257,7 +257,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram.unselected.Marker + :class:`plotly.graph_objs.histogram.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -284,7 +284,7 @@ def __init__(self, arg=None, color=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.histogram.unselected.Marker""" +an instance of :class:`plotly.graph_objs.histogram.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2d/__init__.py index 59290d3f2fb..67d51686017 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2d/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2d/__init__.py @@ -132,7 +132,8 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.YBins + an instance of + :class:`plotly.graph_objs.histogram2d.YBins` end Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin @@ -182,7 +183,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.YBins constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.YBins""" +an instance of :class:`plotly.graph_objs.histogram2d.YBins`""" ) # Handle skip_invalid @@ -351,7 +352,8 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.XBins + an instance of + :class:`plotly.graph_objs.histogram2d.XBins` end Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin @@ -401,7 +403,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.XBins constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.XBins""" +an instance of :class:`plotly.graph_objs.histogram2d.XBins`""" ) # Handle skip_invalid @@ -515,7 +517,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.Stream + an instance of + :class:`plotly.graph_objs.histogram2d.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -545,7 +548,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.Stream constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.Stream""" +an instance of :class:`plotly.graph_objs.histogram2d.Stream`""" ) # Handle skip_invalid @@ -648,7 +651,8 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.Marker + an instance of + :class:`plotly.graph_objs.histogram2d.Marker` color Sets the aggregation data. colorsrc @@ -673,7 +677,7 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.Marker constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.Marker""" +an instance of :class:`plotly.graph_objs.histogram2d.Marker`""" ) # Handle skip_invalid @@ -924,7 +928,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram2d.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.histogram2d.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1079,7 +1083,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.Hoverlabel + an instance of + :class:`plotly.graph_objs.histogram2d.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1128,7 +1133,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2d.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.Hoverlabel""" +an instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel`""" ) # Handle skip_invalid @@ -1808,7 +1813,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.histogram2d.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1942,7 +1947,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.histogram2d.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2180,7 +2185,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.histogram2d.colorbar.Title + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2223,7 +2228,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram2d.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2532,9 +2537,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2d.colorbar.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.histogram2d.col + orbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.histog ram2d.colorbar.tickformatstopdefaults), sets the @@ -2574,8 +2579,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2d.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.colorbar.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use histogram2d.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2669,7 +2674,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.ColorBar + an instance of + :class:`plotly.graph_objs.histogram2d.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2782,9 +2788,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2d.colorbar.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.histogram2d.col + orbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.histog ram2d.colorbar.tickformatstopdefaults), sets the @@ -2824,8 +2830,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2d.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.colorbar.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use histogram2d.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2877,7 +2883,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2d.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.ColorBar""" +an instance of :class:`plotly.graph_objs.histogram2d.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/__init__.py index 680a2256a4c..0a26aa54a47 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram2d.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2d.colorbar.Title + :class:`plotly.graph_objs.histogram2d.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.Title""" +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.histogram2d.co + lorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.histogram2d.co + lorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/__init__.py index d17cb951dab..f26bf8a9e92 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.title.Font + an instance of :class:`plotly.graph_objs.histogram2d.co + lorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2d.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/__init__.py index 51ec23c6ad5..34b24e6a8d2 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2d.hoverlabel.Font + :class:`plotly.graph_objs.histogram2d.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2d.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.histogram2d.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/__init__.py index e6243ea8363..9b77abc4904 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/__init__.py @@ -133,7 +133,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.YBins + :class:`plotly.graph_objs.histogram2dcontour.YBins` end Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin @@ -183,7 +183,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.YBins constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.YBins""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.YBins`""" ) # Handle skip_invalid @@ -353,7 +353,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.XBins + :class:`plotly.graph_objs.histogram2dcontour.XBins` end Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin @@ -403,7 +403,7 @@ def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.XBins constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.XBins""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.XBins`""" ) # Handle skip_invalid @@ -518,7 +518,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.Stream + :class:`plotly.graph_objs.histogram2dcontour.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -548,7 +548,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.Stream constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Stream""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.Stream`""" ) # Handle skip_invalid @@ -652,7 +652,7 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.Marker + :class:`plotly.graph_objs.histogram2dcontour.Marker` color Sets the aggregation data. colorsrc @@ -677,7 +677,7 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.Marker constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Marker""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.Marker`""" ) # Handle skip_invalid @@ -879,7 +879,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.Line + :class:`plotly.graph_objs.histogram2dcontour.Line` color Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines". @@ -913,7 +913,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2dcontour.Line constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Line""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.Line`""" ) # Handle skip_invalid @@ -1170,7 +1170,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1325,8 +1325,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.Hoverlabel + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1375,7 +1375,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2dcontour.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Hoverlabel""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel`""" ) # Handle skip_invalid @@ -1491,7 +1491,7 @@ def labelfont(self): The 'labelfont' property is an instance of Labelfont that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.contours.Labelfont + - An instance of :class:`plotly.graph_objs.histogram2dcontour.contours.Labelfont` - A dict of string/value properties that will be passed to the Labelfont constructor @@ -1804,7 +1804,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.Contours + :class:`plotly.graph_objs.histogram2dcontour.Contours` coloring Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each @@ -1880,7 +1880,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2dcontour.Contours constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Contours""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.Contours`""" ) # Handle skip_invalid @@ -2566,7 +2566,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2700,7 +2700,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2938,7 +2938,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.colorbar.Title + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2982,7 +2982,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -3291,9 +3291,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2dcontour.colo - rbar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.histogram2dcont + our.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.histog ram2dcontour.colorbar.tickformatstopdefaults), sets the @@ -3333,8 +3333,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2dcontour.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.colorba + r.Title` instance or dict with compatible properties titlefont Deprecated: Please use histogram2dcontour.colorbar.title.font instead. Sets @@ -3431,7 +3431,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.histogram2dcontour.ColorBar + :class:`plotly.graph_objs.histogram2dcontour.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -3544,9 +3544,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2dcontour.colo - rbar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.histogram2dcont + our.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.histog ram2dcontour.colorbar.tickformatstopdefaults), sets the @@ -3586,8 +3586,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2dcontour.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour.colorba + r.Title` instance or dict with compatible properties titlefont Deprecated: Please use histogram2dcontour.colorbar.title.font instead. Sets @@ -3641,7 +3641,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2dcontour.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.ColorBar""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py index 0ee57be0345..2573f2c8cf3 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.colorbar.Title + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.Title""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2dcontour.col - orbar.Tickformatstop + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py index 206e641a8c2..d175e8284ab 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2dcontour.col - orbar.title.Font + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/__init__.py index 0fdb7773163..f8fa0e1cdb9 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/__init__.py @@ -153,8 +153,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.contours.Labelfont + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.contours.Labelfont` color family @@ -193,7 +193,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.histogram2dcontour.contours.Labelfont constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.contours.Labelfont""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.contours.Labelfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py index f3d9da986ae..81c99a50453 100644 --- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.hoverlabel.Font + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.histogram2dcontour.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/image/__init__.py b/packages/python/plotly/plotly/graph_objs/image/__init__.py index c64bd8fa927..94e1160511f 100644 --- a/packages/python/plotly/plotly/graph_objs/image/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/image/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.image.Stream + an instance of :class:`plotly.graph_objs.image.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.image.Stream constructor must be a dict or -an instance of plotly.graph_objs.image.Stream""" +an instance of :class:`plotly.graph_objs.image.Stream`""" ) # Handle skip_invalid @@ -358,7 +358,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.image.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.image.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -513,7 +513,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.image.Hoverlabel + an instance of + :class:`plotly.graph_objs.image.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -562,7 +563,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.image.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.image.Hoverlabel""" +an instance of :class:`plotly.graph_objs.image.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/image/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/image/hoverlabel/__init__.py index 931d4f9d962..8ab00e44b4a 100644 --- a/packages/python/plotly/plotly/graph_objs/image/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/image/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.image.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.image.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.image.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.image.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.image.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/__init__.py index 27e2247df23..bee5a1112db 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/__init__.py @@ -36,7 +36,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.indicator.title.Font + - An instance of :class:`plotly.graph_objs.indicator.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -122,7 +122,8 @@ def __init__(self, arg=None, align=None, font=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.Title + an instance of + :class:`plotly.graph_objs.indicator.Title` align Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it @@ -151,7 +152,7 @@ def __init__(self, arg=None, align=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.Title constructor must be a dict or -an instance of plotly.graph_objs.indicator.Title""" +an instance of :class:`plotly.graph_objs.indicator.Title`""" ) # Handle skip_invalid @@ -265,7 +266,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.Stream + an instance of + :class:`plotly.graph_objs.indicator.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -295,7 +297,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.Stream constructor must be a dict or -an instance of plotly.graph_objs.indicator.Stream""" +an instance of :class:`plotly.graph_objs.indicator.Stream`""" ) # Handle skip_invalid @@ -342,7 +344,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.indicator.number.Font + - An instance of :class:`plotly.graph_objs.indicator.number.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -478,7 +480,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.Number + an instance of + :class:`plotly.graph_objs.indicator.Number` font Set the font used to display main number prefix @@ -510,7 +513,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.indicator.Number constructor must be a dict or -an instance of plotly.graph_objs.indicator.Number""" +an instance of :class:`plotly.graph_objs.indicator.Number`""" ) # Handle skip_invalid @@ -561,7 +564,7 @@ def axis(self): """ The 'axis' property is an instance of Axis that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.Axis + - An instance of :class:`plotly.graph_objs.indicator.gauge.Axis` - A dict of string/value properties that will be passed to the Axis constructor @@ -664,9 +667,9 @@ def axis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.indicator.gauge - .axis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.indicat + or.gauge.axis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.indicator.gauge.axis.tickformatstopdefaults), @@ -737,7 +740,7 @@ def bar(self): The 'bar' property is an instance of Bar that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.Bar + - An instance of :class:`plotly.graph_objs.indicator.gauge.Bar` - A dict of string/value properties that will be passed to the Bar constructor @@ -746,8 +749,9 @@ def bar(self): color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.bar.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.ba + r.Line` instance or dict with compatible + properties thickness Sets the thickness of the bar as a fraction of the total thickness of the gauge. @@ -937,8 +941,9 @@ def steps(self): color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.step.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.st + ep.Line` instance or dict with compatible + properties name When used in a template, named items are created in the output figure in addition to any @@ -988,7 +993,7 @@ def stepdefaults(self): The 'stepdefaults' property is an instance of Step that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.Step + - An instance of :class:`plotly.graph_objs.indicator.gauge.Step` - A dict of string/value properties that will be passed to the Step constructor @@ -1011,15 +1016,15 @@ def threshold(self): """ The 'threshold' property is an instance of Threshold that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.Threshold + - An instance of :class:`plotly.graph_objs.indicator.gauge.Threshold` - A dict of string/value properties that will be passed to the Threshold constructor Supported dict properties: line - plotly.graph_objects.indicator.gauge.threshold. - Line instance or dict with compatible + :class:`plotly.graph_objects.indicator.gauge.th + reshold.Line` instance or dict with compatible properties thickness Sets the thickness of the threshold line as a @@ -1049,8 +1054,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ axis - plotly.graph_objects.indicator.gauge.Axis instance or - dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Axis` + instance or dict with compatible properties bar Set the appearance of the gauge's value bgcolor @@ -1063,7 +1068,8 @@ def _prop_descriptions(self): shape Set the shape of the gauge steps - A tuple of plotly.graph_objects.indicator.gauge.Step + A tuple of + :class:`plotly.graph_objects.indicator.gauge.Step` instances or dicts with compatible properties stepdefaults When used in a template (as @@ -1071,8 +1077,8 @@ def _prop_descriptions(self): sets the default property values to use for elements of indicator.gauge.steps threshold - plotly.graph_objects.indicator.gauge.Threshold instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Threshold` + instance or dict with compatible properties """ def __init__( @@ -1098,10 +1104,11 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.Gauge + an instance of + :class:`plotly.graph_objs.indicator.Gauge` axis - plotly.graph_objects.indicator.gauge.Axis instance or - dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Axis` + instance or dict with compatible properties bar Set the appearance of the gauge's value bgcolor @@ -1114,7 +1121,8 @@ def __init__( shape Set the shape of the gauge steps - A tuple of plotly.graph_objects.indicator.gauge.Step + A tuple of + :class:`plotly.graph_objects.indicator.gauge.Step` instances or dicts with compatible properties stepdefaults When used in a template (as @@ -1122,8 +1130,8 @@ def __init__( sets the default property values to use for elements of indicator.gauge.steps threshold - plotly.graph_objects.indicator.gauge.Threshold instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Threshold` + instance or dict with compatible properties Returns ------- @@ -1144,7 +1152,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.indicator.Gauge constructor must be a dict or -an instance of plotly.graph_objs.indicator.Gauge""" +an instance of :class:`plotly.graph_objs.indicator.Gauge`""" ) # Handle skip_invalid @@ -1332,7 +1340,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.Domain + an instance of + :class:`plotly.graph_objs.indicator.Domain` column If there is a layout grid, use the domain for this column in the grid for this indicator trace . @@ -1365,7 +1374,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.Domain constructor must be a dict or -an instance of plotly.graph_objs.indicator.Domain""" +an instance of :class:`plotly.graph_objs.indicator.Domain`""" ) # Handle skip_invalid @@ -1416,7 +1425,7 @@ def decreasing(self): """ The 'decreasing' property is an instance of Decreasing that may be specified as: - - An instance of plotly.graph_objs.indicator.delta.Decreasing + - An instance of :class:`plotly.graph_objs.indicator.delta.Decreasing` - A dict of string/value properties that will be passed to the Decreasing constructor @@ -1446,7 +1455,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.indicator.delta.Font + - An instance of :class:`plotly.graph_objs.indicator.delta.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1489,7 +1498,7 @@ def increasing(self): """ The 'increasing' property is an instance of Increasing that may be specified as: - - An instance of plotly.graph_objs.indicator.delta.Increasing + - An instance of :class:`plotly.graph_objs.indicator.delta.Increasing` - A dict of string/value properties that will be passed to the Increasing constructor @@ -1608,13 +1617,13 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ decreasing - plotly.graph_objects.indicator.delta.Decreasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.Decreasing + ` instance or dict with compatible properties font Set the font used to display the delta increasing - plotly.graph_objects.indicator.delta.Increasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.Increasing + ` instance or dict with compatible properties position Sets the position of delta with respect to the number. reference @@ -1648,15 +1657,16 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.Delta + an instance of + :class:`plotly.graph_objs.indicator.Delta` decreasing - plotly.graph_objects.indicator.delta.Decreasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.Decreasing + ` instance or dict with compatible properties font Set the font used to display the delta increasing - plotly.graph_objects.indicator.delta.Increasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.Increasing + ` instance or dict with compatible properties position Sets the position of delta with respect to the number. reference @@ -1689,7 +1699,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.indicator.Delta constructor must be a dict or -an instance of plotly.graph_objs.indicator.Delta""" +an instance of :class:`plotly.graph_objs.indicator.Delta`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/delta/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/delta/__init__.py index a15a8cb2efd..2b7f4c67712 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/delta/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/delta/__init__.py @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, symbol=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.indicator.delta.Increasing + :class:`plotly.graph_objs.indicator.delta.Increasing` color Sets the color for increasing value. symbol @@ -135,7 +135,7 @@ def __init__(self, arg=None, color=None, symbol=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.delta.Increasing constructor must be a dict or -an instance of plotly.graph_objs.indicator.delta.Increasing""" +an instance of :class:`plotly.graph_objs.indicator.delta.Increasing`""" ) # Handle skip_invalid @@ -320,7 +320,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.delta.Font + an instance of + :class:`plotly.graph_objs.indicator.delta.Font` color family @@ -359,7 +360,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.delta.Font constructor must be a dict or -an instance of plotly.graph_objs.indicator.delta.Font""" +an instance of :class:`plotly.graph_objs.indicator.delta.Font`""" ) # Handle skip_invalid @@ -506,7 +507,7 @@ def __init__(self, arg=None, color=None, symbol=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.indicator.delta.Decreasing + :class:`plotly.graph_objs.indicator.delta.Decreasing` color Sets the color for increasing value. symbol @@ -531,7 +532,7 @@ def __init__(self, arg=None, color=None, symbol=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.delta.Decreasing constructor must be a dict or -an instance of plotly.graph_objs.indicator.delta.Decreasing""" +an instance of :class:`plotly.graph_objs.indicator.delta.Decreasing`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/__init__.py index b89c9bc661b..f6736c6c864 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/__init__.py @@ -11,7 +11,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.threshold.Line + - An instance of :class:`plotly.graph_objs.indicator.gauge.threshold.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -85,8 +85,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ line - plotly.graph_objects.indicator.gauge.threshold.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.threshold. + Line` instance or dict with compatible properties thickness Sets the thickness of the threshold line as a fraction of the thickness of the gauge. @@ -103,10 +103,10 @@ def __init__(self, arg=None, line=None, thickness=None, value=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.indicator.gauge.Threshold + :class:`plotly.graph_objs.indicator.gauge.Threshold` line - plotly.graph_objects.indicator.gauge.threshold.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.threshold. + Line` instance or dict with compatible properties thickness Sets the thickness of the threshold line as a fraction of the thickness of the gauge. @@ -132,7 +132,7 @@ def __init__(self, arg=None, line=None, thickness=None, value=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.gauge.Threshold constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.Threshold""" +an instance of :class:`plotly.graph_objs.indicator.gauge.Threshold`""" ) # Handle skip_invalid @@ -239,7 +239,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.step.Line + - An instance of :class:`plotly.graph_objs.indicator.gauge.step.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -377,8 +377,8 @@ def _prop_descriptions(self): color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.step.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.step.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure @@ -423,12 +423,13 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.gauge.Step + an instance of + :class:`plotly.graph_objs.indicator.gauge.Step` color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.step.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.step.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure @@ -473,7 +474,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.indicator.gauge.Step constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.Step""" +an instance of :class:`plotly.graph_objs.indicator.gauge.Step`""" ) # Handle skip_invalid @@ -591,7 +592,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.bar.Line + - An instance of :class:`plotly.graph_objs.indicator.gauge.bar.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -649,8 +650,8 @@ def _prop_descriptions(self): color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.bar.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.bar.Line` + instance or dict with compatible properties thickness Sets the thickness of the bar as a fraction of the total thickness of the gauge. @@ -666,12 +667,13 @@ def __init__(self, arg=None, color=None, line=None, thickness=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.gauge.Bar + an instance of + :class:`plotly.graph_objs.indicator.gauge.Bar` color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.bar.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.bar.Line` + instance or dict with compatible properties thickness Sets the thickness of the bar as a fraction of the total thickness of the gauge. @@ -695,7 +697,7 @@ def __init__(self, arg=None, color=None, line=None, thickness=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.gauge.Bar constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.Bar""" +an instance of :class:`plotly.graph_objs.indicator.gauge.Bar`""" ) # Handle skip_invalid @@ -1076,7 +1078,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.axis.Tickfont + - An instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1210,7 +1212,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.indicator.gauge.axis.Tickformatstop + - An instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1560,9 +1562,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.indicator.gauge.axis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.indicator.gauge + .axis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.indica tor.gauge.axis.tickformatstopdefaults), sets the @@ -1646,7 +1648,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.gauge.Axis + an instance of + :class:`plotly.graph_objs.indicator.gauge.Axis` dtick Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings @@ -1733,9 +1736,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.indicator.gauge.axis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.indicator.gauge + .axis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.indica tor.gauge.axis.tickformatstopdefaults), sets the @@ -1798,7 +1801,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.indicator.gauge.Axis constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.Axis""" +an instance of :class:`plotly.graph_objs.indicator.gauge.Axis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/__init__.py index 7723fd3f54d..0bad6766b31 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/__init__.py @@ -187,8 +187,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.indicator.gauge.axis.Tickformatstop + an instance of :class:`plotly.graph_objs.indicator.gaug + e.axis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -239,7 +239,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.indicator.gauge.axis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.axis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickformatstop`""" ) # Handle skip_invalid @@ -439,8 +439,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.indicator.gauge.axis.Tickfont + an instance of :class:`plotly.graph_objs.indicator.gaug + e.axis.Tickfont` color family @@ -479,7 +479,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.gauge.axis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.axis.Tickfont""" +an instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/__init__.py index 4dee3b2a06f..1aa91828401 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/__init__.py @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.indicator.gauge.bar.Line + :class:`plotly.graph_objs.indicator.gauge.bar.Line` color Sets the color of the line enclosing each sector. width @@ -136,7 +136,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.gauge.bar.Line constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.bar.Line""" +an instance of :class:`plotly.graph_objs.indicator.gauge.bar.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/__init__.py index ee3c9dcaaf8..dbc901aea8a 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/__init__.py @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.indicator.gauge.step.Line + :class:`plotly.graph_objs.indicator.gauge.step.Line` color Sets the color of the line enclosing each sector. width @@ -136,7 +136,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.gauge.step.Line constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.step.Line""" +an instance of :class:`plotly.graph_objs.indicator.gauge.step.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/__init__.py index 2a0511548cf..bc8e9d10de2 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/__init__.py @@ -108,8 +108,8 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.indicator.gauge.threshold.Line + an instance of :class:`plotly.graph_objs.indicator.gaug + e.threshold.Line` color Sets the color of the threshold line. width @@ -134,7 +134,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.gauge.threshold.Line constructor must be a dict or -an instance of plotly.graph_objs.indicator.gauge.threshold.Line""" +an instance of :class:`plotly.graph_objs.indicator.gauge.threshold.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/number/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/number/__init__.py index f7943fb4ad0..079b9da2944 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/number/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/number/__init__.py @@ -151,7 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.number.Font + an instance of + :class:`plotly.graph_objs.indicator.number.Font` color family @@ -190,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.number.Font constructor must be a dict or -an instance of plotly.graph_objs.indicator.number.Font""" +an instance of :class:`plotly.graph_objs.indicator.number.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/indicator/title/__init__.py b/packages/python/plotly/plotly/graph_objs/indicator/title/__init__.py index b4b4bdbc9cc..3ac8b3ed182 100644 --- a/packages/python/plotly/plotly/graph_objs/indicator/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/indicator/title/__init__.py @@ -151,7 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.indicator.title.Font + an instance of + :class:`plotly.graph_objs.indicator.title.Font` color family @@ -190,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.indicator.title.Font constructor must be a dict or -an instance of plotly.graph_objs.indicator.title.Font""" +an instance of :class:`plotly.graph_objs.indicator.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/__init__.py b/packages/python/plotly/plotly/graph_objs/isosurface/__init__.py index 32470a0b482..af503ef4fc8 100644 --- a/packages/python/plotly/plotly/graph_objs/isosurface/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/isosurface/__init__.py @@ -145,7 +145,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Surface + an instance of + :class:`plotly.graph_objs.isosurface.Surface` count Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning @@ -189,7 +190,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.Surface constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Surface""" +an instance of :class:`plotly.graph_objs.isosurface.Surface`""" ) # Handle skip_invalid @@ -306,7 +307,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Stream + an instance of + :class:`plotly.graph_objs.isosurface.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -336,7 +338,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.Stream constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Stream""" +an instance of :class:`plotly.graph_objs.isosurface.Stream`""" ) # Handle skip_invalid @@ -453,7 +455,8 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Spaceframe + an instance of + :class:`plotly.graph_objs.isosurface.Spaceframe` fill Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the @@ -486,7 +489,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.Spaceframe constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Spaceframe""" +an instance of :class:`plotly.graph_objs.isosurface.Spaceframe`""" ) # Handle skip_invalid @@ -531,7 +534,7 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of plotly.graph_objs.isosurface.slices.X + - An instance of :class:`plotly.graph_objs.isosurface.slices.X` - A dict of string/value properties that will be passed to the X constructor @@ -573,7 +576,7 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of plotly.graph_objs.isosurface.slices.Y + - An instance of :class:`plotly.graph_objs.isosurface.slices.Y` - A dict of string/value properties that will be passed to the Y constructor @@ -615,7 +618,7 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of plotly.graph_objs.isosurface.slices.Z + - An instance of :class:`plotly.graph_objs.isosurface.slices.Z` - A dict of string/value properties that will be passed to the Z constructor @@ -662,14 +665,14 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ x - plotly.graph_objects.isosurface.slices.X instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices.X` + instance or dict with compatible properties y - plotly.graph_objects.isosurface.slices.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices.Y` + instance or dict with compatible properties z - plotly.graph_objects.isosurface.slices.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices.Z` + instance or dict with compatible properties """ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): @@ -680,16 +683,17 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Slices + an instance of + :class:`plotly.graph_objs.isosurface.Slices` x - plotly.graph_objects.isosurface.slices.X instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices.X` + instance or dict with compatible properties y - plotly.graph_objects.isosurface.slices.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices.Y` + instance or dict with compatible properties z - plotly.graph_objects.isosurface.slices.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices.Z` + instance or dict with compatible properties Returns ------- @@ -710,7 +714,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.Slices constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Slices""" +an instance of :class:`plotly.graph_objs.isosurface.Slices`""" ) # Handle skip_invalid @@ -842,7 +846,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.isosurface.Lightposition + :class:`plotly.graph_objs.isosurface.Lightposition` x Numeric vector, representing the X coordinate for each vertex. @@ -872,7 +876,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.Lightposition constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Lightposition""" +an instance of :class:`plotly.graph_objs.isosurface.Lightposition`""" ) # Handle skip_invalid @@ -1116,7 +1120,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Lighting + an instance of + :class:`plotly.graph_objs.isosurface.Lighting` ambient Ambient light increases overall color visibility but can wash out the image. @@ -1160,7 +1165,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.Lighting constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Lighting""" +an instance of :class:`plotly.graph_objs.isosurface.Lighting`""" ) # Handle skip_invalid @@ -1434,7 +1439,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.isosurface.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.isosurface.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1589,7 +1594,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Hoverlabel + an instance of + :class:`plotly.graph_objs.isosurface.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1638,7 +1644,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Hoverlabel""" +an instance of :class:`plotly.graph_objs.isosurface.Hoverlabel`""" ) # Handle skip_invalid @@ -1823,7 +1829,8 @@ def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Contour + an instance of + :class:`plotly.graph_objs.isosurface.Contour` color Sets the color of the contour lines. show @@ -1850,7 +1857,7 @@ def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.Contour constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Contour""" +an instance of :class:`plotly.graph_objs.isosurface.Contour`""" ) # Handle skip_invalid @@ -2512,7 +2519,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.isosurface.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2645,7 +2652,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.isosurface.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2883,7 +2890,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.isosurface.colorbar.Title + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2926,7 +2933,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.isosurface.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -3235,9 +3242,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.isosurface.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.isosurface.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.isosur face.colorbar.tickformatstopdefaults), sets the default @@ -3277,8 +3284,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.isosurface.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use isosurface.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -3372,7 +3379,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.ColorBar + an instance of + :class:`plotly.graph_objs.isosurface.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -3485,9 +3493,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.isosurface.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.isosurface.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.isosur face.colorbar.tickformatstopdefaults), sets the default @@ -3527,8 +3535,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.isosurface.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use isosurface.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -3580,7 +3588,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.isosurface.ColorBar""" +an instance of :class:`plotly.graph_objs.isosurface.ColorBar`""" ) # Handle skip_invalid @@ -3756,7 +3764,7 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of plotly.graph_objs.isosurface.caps.X + - An instance of :class:`plotly.graph_objs.isosurface.caps.X` - A dict of string/value properties that will be passed to the X constructor @@ -3793,7 +3801,7 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of plotly.graph_objs.isosurface.caps.Y + - An instance of :class:`plotly.graph_objs.isosurface.caps.Y` - A dict of string/value properties that will be passed to the Y constructor @@ -3830,7 +3838,7 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of plotly.graph_objs.isosurface.caps.Z + - An instance of :class:`plotly.graph_objs.isosurface.caps.Z` - A dict of string/value properties that will be passed to the Z constructor @@ -3872,14 +3880,14 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ x - plotly.graph_objects.isosurface.caps.X instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.caps.X` + instance or dict with compatible properties y - plotly.graph_objects.isosurface.caps.Y instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Y` + instance or dict with compatible properties z - plotly.graph_objects.isosurface.caps.Z instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Z` + instance or dict with compatible properties """ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): @@ -3890,16 +3898,17 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Caps + an instance of + :class:`plotly.graph_objs.isosurface.Caps` x - plotly.graph_objects.isosurface.caps.X instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.caps.X` + instance or dict with compatible properties y - plotly.graph_objects.isosurface.caps.Y instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Y` + instance or dict with compatible properties z - plotly.graph_objects.isosurface.caps.Z instance or dict - with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Z` + instance or dict with compatible properties Returns ------- @@ -3920,7 +3929,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.Caps constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Caps""" +an instance of :class:`plotly.graph_objs.isosurface.Caps`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/caps/__init__.py b/packages/python/plotly/plotly/graph_objs/isosurface/caps/__init__.py index 71b0cf9b587..cce84884b08 100644 --- a/packages/python/plotly/plotly/graph_objs/isosurface/caps/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/isosurface/caps/__init__.py @@ -83,7 +83,8 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.caps.Z + an instance of + :class:`plotly.graph_objs.isosurface.caps.Z` fill Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely @@ -116,7 +117,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.caps.Z constructor must be a dict or -an instance of plotly.graph_objs.isosurface.caps.Z""" +an instance of :class:`plotly.graph_objs.isosurface.caps.Z`""" ) # Handle skip_invalid @@ -233,7 +234,8 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.caps.Y + an instance of + :class:`plotly.graph_objs.isosurface.caps.Y` fill Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely @@ -266,7 +268,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.caps.Y constructor must be a dict or -an instance of plotly.graph_objs.isosurface.caps.Y""" +an instance of :class:`plotly.graph_objs.isosurface.caps.Y`""" ) # Handle skip_invalid @@ -383,7 +385,8 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.caps.X + an instance of + :class:`plotly.graph_objs.isosurface.caps.X` fill Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely @@ -416,7 +419,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.caps.X constructor must be a dict or -an instance of plotly.graph_objs.isosurface.caps.X""" +an instance of :class:`plotly.graph_objs.isosurface.caps.X`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/__init__.py index c55639f8a3a..c353fa49088 100644 --- a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.isosurface.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.isosurface.colorbar.Title + :class:`plotly.graph_objs.isosurface.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.Title""" +an instance of :class:`plotly.graph_objs.isosurface.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.isosurface.col + orbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -644,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.isosurface.colorbar.Tickfont + :class:`plotly.graph_objs.isosurface.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/__init__.py index 4a84f9de127..86883aeae8d 100644 --- a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.colorbar.title.Font + an instance of :class:`plotly.graph_objs.isosurface.col + orbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.isosurface.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.isosurface.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/__init__.py index 402217fb94c..f19a46d58ed 100644 --- a/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.isosurface.hoverlabel.Font + :class:`plotly.graph_objs.isosurface.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.isosurface.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.isosurface.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/slices/__init__.py b/packages/python/plotly/plotly/graph_objs/isosurface/slices/__init__.py index 8d3855f124c..f9c0d897365 100644 --- a/packages/python/plotly/plotly/graph_objs/isosurface/slices/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/isosurface/slices/__init__.py @@ -134,7 +134,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.slices.Z + an instance of + :class:`plotly.graph_objs.isosurface.slices.Z` fill Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are @@ -170,7 +171,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.slices.Z constructor must be a dict or -an instance of plotly.graph_objs.isosurface.slices.Z""" +an instance of :class:`plotly.graph_objs.isosurface.slices.Z`""" ) # Handle skip_invalid @@ -344,7 +345,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.slices.Y + an instance of + :class:`plotly.graph_objs.isosurface.slices.Y` fill Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are @@ -380,7 +382,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.slices.Y constructor must be a dict or -an instance of plotly.graph_objs.isosurface.slices.Y""" +an instance of :class:`plotly.graph_objs.isosurface.slices.Y`""" ) # Handle skip_invalid @@ -554,7 +556,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.slices.X + an instance of + :class:`plotly.graph_objs.isosurface.slices.X` fill Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are @@ -590,7 +593,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.isosurface.slices.X constructor must be a dict or -an instance of plotly.graph_objs.isosurface.slices.X""" +an instance of :class:`plotly.graph_objs.isosurface.slices.X`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/__init__.py index ce901d5c07f..e614a66b802 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/__init__.py @@ -1427,7 +1427,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.yaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1561,7 +1561,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.yaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.yaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1824,7 +1824,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.yaxis.Title + - An instance of :class:`plotly.graph_objs.layout.yaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1874,7 +1874,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.yaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.yaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2383,9 +2383,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.yaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.yaxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.yaxis.tickformatstopdefaults), @@ -2432,8 +2432,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.yaxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.yaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.yaxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -2547,7 +2547,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.YAxis + an instance of :class:`plotly.graph_objs.layout.YAxis` anchor If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter @@ -2842,9 +2842,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.yaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.yaxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.yaxis.tickformatstopdefaults), @@ -2891,8 +2891,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.yaxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.yaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.yaxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -2938,7 +2938,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.YAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.YAxis""" +an instance of :class:`plotly.graph_objs.layout.YAxis`""" ) # Handle skip_invalid @@ -4074,7 +4074,7 @@ def rangeselector(self): """ The 'rangeselector' property is an instance of Rangeselector that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.Rangeselector + - An instance of :class:`plotly.graph_objs.layout.xaxis.Rangeselector` - A dict of string/value properties that will be passed to the Rangeselector constructor @@ -4143,7 +4143,7 @@ def rangeslider(self): """ The 'rangeslider' property is an instance of Rangeslider that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.Rangeslider + - An instance of :class:`plotly.graph_objs.layout.xaxis.Rangeslider` - A dict of string/value properties that will be passed to the Rangeslider constructor @@ -4180,8 +4180,8 @@ def rangeslider(self): be visible. If visible, perpendicular axes will be set to `fixedrange` yaxis - plotly.graph_objects.layout.xaxis.rangeslider.Y - Axis instance or dict with compatible + :class:`plotly.graph_objects.layout.xaxis.range + slider.YAxis` instance or dict with compatible properties Returns @@ -4743,7 +4743,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.xaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -4877,7 +4877,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.xaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -5140,7 +5140,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.Title + - An instance of :class:`plotly.graph_objs.layout.xaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -5190,7 +5190,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.xaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -5585,11 +5585,11 @@ def _prop_descriptions(self): "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes. rangeselector - plotly.graph_objects.layout.xaxis.Rangeselector - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Rangeselector + ` instance or dict with compatible properties rangeslider - plotly.graph_objects.layout.xaxis.Rangeslider instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Rangeslider` + instance or dict with compatible properties scaleanchor If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the @@ -5705,9 +5705,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.xaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.xaxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.xaxis.tickformatstopdefaults), @@ -5754,8 +5754,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.xaxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.xaxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -5871,7 +5871,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.XAxis + an instance of :class:`plotly.graph_objs.layout.XAxis` anchor If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter @@ -6052,11 +6052,11 @@ def __init__( "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes. rangeselector - plotly.graph_objects.layout.xaxis.Rangeselector - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Rangeselector + ` instance or dict with compatible properties rangeslider - plotly.graph_objects.layout.xaxis.Rangeslider instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Rangeslider` + instance or dict with compatible properties scaleanchor If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the @@ -6172,9 +6172,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.xaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.xaxis.Ti + ckformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.xaxis.tickformatstopdefaults), @@ -6221,8 +6221,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.xaxis.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.xaxis.title.font instead. Sets this axis' title font. Note that the title's font @@ -6268,7 +6268,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.XAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.XAxis""" +an instance of :class:`plotly.graph_objs.layout.XAxis`""" ) # Handle skip_invalid @@ -6778,7 +6778,7 @@ def buttondefaults(self): The 'buttondefaults' property is an instance of Button that may be specified as: - - An instance of plotly.graph_objs.layout.updatemenu.Button + - An instance of :class:`plotly.graph_objs.layout.updatemenu.Button` - A dict of string/value properties that will be passed to the Button constructor @@ -6827,7 +6827,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.updatemenu.Font + - An instance of :class:`plotly.graph_objs.layout.updatemenu.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -6899,7 +6899,7 @@ def pad(self): The 'pad' property is an instance of Pad that may be specified as: - - An instance of plotly.graph_objs.layout.updatemenu.Pad + - An instance of :class:`plotly.graph_objs.layout.updatemenu.Pad` - A dict of string/value properties that will be passed to the Pad constructor @@ -7130,8 +7130,8 @@ def _prop_descriptions(self): update menu. buttons A tuple of - plotly.graph_objects.layout.updatemenu.Button instances - or dicts with compatible properties + :class:`plotly.graph_objects.layout.updatemenu.Button` + instances or dicts with compatible properties buttondefaults When used in a template (as layout.template.layout.updatemenu.buttondefaults), sets @@ -7221,7 +7221,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Updatemenu + an instance of + :class:`plotly.graph_objs.layout.Updatemenu` active Determines which button (by index starting from 0) is considered active. @@ -7234,8 +7235,8 @@ def __init__( update menu. buttons A tuple of - plotly.graph_objects.layout.updatemenu.Button instances - or dicts with compatible properties + :class:`plotly.graph_objects.layout.updatemenu.Button` + instances or dicts with compatible properties buttondefaults When used in a template (as layout.template.layout.updatemenu.buttondefaults), sets @@ -7313,7 +7314,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Updatemenu constructor must be a dict or -an instance of plotly.graph_objs.layout.Updatemenu""" +an instance of :class:`plotly.graph_objs.layout.Updatemenu`""" ) # Handle skip_invalid @@ -7482,7 +7483,8 @@ def __init__(self, arg=None, minsize=None, mode=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Uniformtext + an instance of + :class:`plotly.graph_objs.layout.Uniformtext` minsize Sets the minimum text size between traces of the same type. @@ -7515,7 +7517,7 @@ def __init__(self, arg=None, minsize=None, mode=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.Uniformtext constructor must be a dict or -an instance of plotly.graph_objs.layout.Uniformtext""" +an instance of :class:`plotly.graph_objs.layout.Uniformtext`""" ) # Handle skip_invalid @@ -7658,7 +7660,8 @@ def __init__(self, arg=None, duration=None, easing=None, ordering=None, **kwargs ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Transition + an instance of + :class:`plotly.graph_objs.layout.Transition` duration The duration of the transition, in milliseconds. If equal to zero, updates are synchronous. @@ -7688,7 +7691,7 @@ def __init__(self, arg=None, duration=None, easing=None, ordering=None, **kwargs """\ The first argument to the plotly.graph_objs.layout.Transition constructor must be a dict or -an instance of plotly.graph_objs.layout.Transition""" +an instance of :class:`plotly.graph_objs.layout.Transition`""" ) # Handle skip_invalid @@ -7739,7 +7742,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.title.Font + - An instance of :class:`plotly.graph_objs.layout.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -7789,7 +7792,7 @@ def pad(self): The 'pad' property is an instance of Pad that may be specified as: - - An instance of plotly.graph_objs.layout.title.Pad + - An instance of :class:`plotly.graph_objs.layout.title.Pad` - A dict of string/value properties that will be passed to the Pad constructor @@ -8064,7 +8067,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Title + an instance of :class:`plotly.graph_objs.layout.Title` font Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -8132,7 +8135,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.Title""" +an instance of :class:`plotly.graph_objs.layout.Title`""" ) # Handle skip_invalid @@ -8198,7 +8201,7 @@ def aaxis(self): """ The 'aaxis' property is an instance of Aaxis that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.Aaxis + - An instance of :class:`plotly.graph_objs.layout.ternary.Aaxis` - A dict of string/value properties that will be passed to the Aaxis constructor @@ -8348,9 +8351,9 @@ def aaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary. - aaxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + ternary.aaxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.ternary.aaxis.tickformatstopdefaults), sets @@ -8396,8 +8399,9 @@ def aaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.aaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.aax + is.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.ternary.aaxis.title.font instead. Sets @@ -8427,7 +8431,7 @@ def baxis(self): """ The 'baxis' property is an instance of Baxis that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.Baxis + - An instance of :class:`plotly.graph_objs.layout.ternary.Baxis` - A dict of string/value properties that will be passed to the Baxis constructor @@ -8577,9 +8581,9 @@ def baxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary. - baxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + ternary.baxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.ternary.baxis.tickformatstopdefaults), sets @@ -8625,8 +8629,9 @@ def baxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.baxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.bax + is.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.ternary.baxis.title.font instead. Sets @@ -8715,7 +8720,7 @@ def caxis(self): """ The 'caxis' property is an instance of Caxis that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.Caxis + - An instance of :class:`plotly.graph_objs.layout.ternary.Caxis` - A dict of string/value properties that will be passed to the Caxis constructor @@ -8865,9 +8870,9 @@ def caxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary. - caxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + ternary.caxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.ternary.caxis.tickformatstopdefaults), sets @@ -8913,8 +8918,9 @@ def caxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.caxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.cax + is.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.ternary.caxis.title.font instead. Sets @@ -8944,7 +8950,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.Domain + - An instance of :class:`plotly.graph_objs.layout.ternary.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -9028,19 +9034,19 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ aaxis - plotly.graph_objects.layout.ternary.Aaxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Aaxis` + instance or dict with compatible properties baxis - plotly.graph_objects.layout.ternary.Baxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Baxis` + instance or dict with compatible properties bgcolor Set the background color of the subplot caxis - plotly.graph_objects.layout.ternary.Caxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Caxis` + instance or dict with compatible properties domain - plotly.graph_objects.layout.ternary.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Domain` + instance or dict with compatible properties sum The number each triplet should sum to, and the maximum range of each axis @@ -9069,21 +9075,22 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Ternary + an instance of + :class:`plotly.graph_objs.layout.Ternary` aaxis - plotly.graph_objects.layout.ternary.Aaxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Aaxis` + instance or dict with compatible properties baxis - plotly.graph_objects.layout.ternary.Baxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Baxis` + instance or dict with compatible properties bgcolor Set the background color of the subplot caxis - plotly.graph_objects.layout.ternary.Caxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Caxis` + instance or dict with compatible properties domain - plotly.graph_objects.layout.ternary.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Domain` + instance or dict with compatible properties sum The number each triplet should sum to, and the maximum range of each axis @@ -9111,7 +9118,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Ternary constructor must be a dict or -an instance of plotly.graph_objs.layout.Ternary""" +an instance of :class:`plotly.graph_objs.layout.Ternary`""" ) # Handle skip_invalid @@ -9171,154 +9178,184 @@ def data(self): """ The 'data' property is an instance of Data that may be specified as: - - An instance of plotly.graph_objs.layout.template.Data + - An instance of :class:`plotly.graph_objs.layout.template.Data` - A dict of string/value properties that will be passed to the Data constructor Supported dict properties: area - A tuple of plotly.graph_objects.Area instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Area` + instances or dicts with compatible properties barpolar - A tuple of plotly.graph_objects.Barpolar + A tuple of + :class:`plotly.graph_objects.Barpolar` instances or dicts with compatible properties bar - A tuple of plotly.graph_objects.Bar instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Bar` + instances or dicts with compatible properties box - A tuple of plotly.graph_objects.Box instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Box` + instances or dicts with compatible properties candlestick - A tuple of plotly.graph_objects.Candlestick + A tuple of + :class:`plotly.graph_objects.Candlestick` instances or dicts with compatible properties carpet - A tuple of plotly.graph_objects.Carpet + A tuple of :class:`plotly.graph_objects.Carpet` instances or dicts with compatible properties choroplethmapbox A tuple of - plotly.graph_objects.Choroplethmapbox instances - or dicts with compatible properties + :class:`plotly.graph_objects.Choroplethmapbox` + instances or dicts with compatible properties choropleth - A tuple of plotly.graph_objects.Choropleth + A tuple of + :class:`plotly.graph_objects.Choropleth` instances or dicts with compatible properties cone - A tuple of plotly.graph_objects.Cone instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Cone` + instances or dicts with compatible properties contourcarpet - A tuple of plotly.graph_objects.Contourcarpet + A tuple of + :class:`plotly.graph_objects.Contourcarpet` instances or dicts with compatible properties contour - A tuple of plotly.graph_objects.Contour - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.Contour` instances + or dicts with compatible properties densitymapbox - A tuple of plotly.graph_objects.Densitymapbox + A tuple of + :class:`plotly.graph_objects.Densitymapbox` instances or dicts with compatible properties funnelarea - A tuple of plotly.graph_objects.Funnelarea + A tuple of + :class:`plotly.graph_objects.Funnelarea` instances or dicts with compatible properties funnel - A tuple of plotly.graph_objects.Funnel + A tuple of :class:`plotly.graph_objects.Funnel` instances or dicts with compatible properties heatmapgl - A tuple of plotly.graph_objects.Heatmapgl + A tuple of + :class:`plotly.graph_objects.Heatmapgl` instances or dicts with compatible properties heatmap - A tuple of plotly.graph_objects.Heatmap - instances or dicts with compatible properties - histogram2dcontour A tuple of - plotly.graph_objects.Histogram2dContour - instances or dicts with compatible properties + :class:`plotly.graph_objects.Heatmap` instances + or dicts with compatible properties + histogram2dcontour + A tuple of :class:`plotly.graph_objects.Histogr + am2dContour` instances or dicts with compatible + properties histogram2d - A tuple of plotly.graph_objects.Histogram2d + A tuple of + :class:`plotly.graph_objects.Histogram2d` instances or dicts with compatible properties histogram - A tuple of plotly.graph_objects.Histogram + A tuple of + :class:`plotly.graph_objects.Histogram` instances or dicts with compatible properties image - A tuple of plotly.graph_objects.Image instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Image` + instances or dicts with compatible properties indicator - A tuple of plotly.graph_objects.Indicator + A tuple of + :class:`plotly.graph_objects.Indicator` instances or dicts with compatible properties isosurface - A tuple of plotly.graph_objects.Isosurface + A tuple of + :class:`plotly.graph_objects.Isosurface` instances or dicts with compatible properties mesh3d - A tuple of plotly.graph_objects.Mesh3d + A tuple of :class:`plotly.graph_objects.Mesh3d` instances or dicts with compatible properties ohlc - A tuple of plotly.graph_objects.Ohlc instances - or dicts with compatible properties - parcats - A tuple of plotly.graph_objects.Parcats + A tuple of :class:`plotly.graph_objects.Ohlc` instances or dicts with compatible properties + parcats + A tuple of + :class:`plotly.graph_objects.Parcats` instances + or dicts with compatible properties parcoords - A tuple of plotly.graph_objects.Parcoords + A tuple of + :class:`plotly.graph_objects.Parcoords` instances or dicts with compatible properties pie - A tuple of plotly.graph_objects.Pie instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Pie` + instances or dicts with compatible properties pointcloud - A tuple of plotly.graph_objects.Pointcloud + A tuple of + :class:`plotly.graph_objects.Pointcloud` instances or dicts with compatible properties sankey - A tuple of plotly.graph_objects.Sankey + A tuple of :class:`plotly.graph_objects.Sankey` instances or dicts with compatible properties scatter3d - A tuple of plotly.graph_objects.Scatter3d + A tuple of + :class:`plotly.graph_objects.Scatter3d` instances or dicts with compatible properties scattercarpet - A tuple of plotly.graph_objects.Scattercarpet + A tuple of + :class:`plotly.graph_objects.Scattercarpet` instances or dicts with compatible properties scattergeo - A tuple of plotly.graph_objects.Scattergeo + A tuple of + :class:`plotly.graph_objects.Scattergeo` instances or dicts with compatible properties scattergl - A tuple of plotly.graph_objects.Scattergl + A tuple of + :class:`plotly.graph_objects.Scattergl` instances or dicts with compatible properties scattermapbox - A tuple of plotly.graph_objects.Scattermapbox + A tuple of + :class:`plotly.graph_objects.Scattermapbox` instances or dicts with compatible properties scatterpolargl - A tuple of plotly.graph_objects.Scatterpolargl + A tuple of + :class:`plotly.graph_objects.Scatterpolargl` instances or dicts with compatible properties scatterpolar - A tuple of plotly.graph_objects.Scatterpolar + A tuple of + :class:`plotly.graph_objects.Scatterpolar` instances or dicts with compatible properties scatter - A tuple of plotly.graph_objects.Scatter - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.Scatter` instances + or dicts with compatible properties scatterternary - A tuple of plotly.graph_objects.Scatterternary + A tuple of + :class:`plotly.graph_objects.Scatterternary` instances or dicts with compatible properties splom - A tuple of plotly.graph_objects.Splom instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Splom` + instances or dicts with compatible properties streamtube - A tuple of plotly.graph_objects.Streamtube + A tuple of + :class:`plotly.graph_objects.Streamtube` instances or dicts with compatible properties sunburst - A tuple of plotly.graph_objects.Sunburst + A tuple of + :class:`plotly.graph_objects.Sunburst` instances or dicts with compatible properties surface - A tuple of plotly.graph_objects.Surface - instances or dicts with compatible properties - table - A tuple of plotly.graph_objects.Table instances + A tuple of + :class:`plotly.graph_objects.Surface` instances or dicts with compatible properties - treemap - A tuple of plotly.graph_objects.Treemap + table + A tuple of :class:`plotly.graph_objects.Table` instances or dicts with compatible properties + treemap + A tuple of + :class:`plotly.graph_objects.Treemap` instances + or dicts with compatible properties violin - A tuple of plotly.graph_objects.Violin + A tuple of :class:`plotly.graph_objects.Violin` instances or dicts with compatible properties volume - A tuple of plotly.graph_objects.Volume + A tuple of :class:`plotly.graph_objects.Volume` instances or dicts with compatible properties waterfall - A tuple of plotly.graph_objects.Waterfall + A tuple of + :class:`plotly.graph_objects.Waterfall` instances or dicts with compatible properties Returns @@ -9338,7 +9375,7 @@ def layout(self): """ The 'layout' property is an instance of Layout that may be specified as: - - An instance of plotly.graph_objs.Layout + - An instance of :class:`plotly.graph_objs.Layout` - A dict of string/value properties that will be passed to the Layout constructor @@ -9366,11 +9403,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ data - plotly.graph_objects.layout.template.Data instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.template.Data` + instance or dict with compatible properties layout - plotly.graph_objects.Layout instance or dict with - compatible properties + :class:`plotly.graph_objects.Layout` instance or dict + with compatible properties """ def __init__(self, arg=None, data=None, layout=None, **kwargs): @@ -9401,13 +9438,14 @@ def __init__(self, arg=None, data=None, layout=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Template + an instance of + :class:`plotly.graph_objs.layout.Template` data - plotly.graph_objects.layout.template.Data instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.template.Data` + instance or dict with compatible properties layout - plotly.graph_objects.Layout instance or dict with - compatible properties + :class:`plotly.graph_objects.Layout` instance or dict + with compatible properties Returns ------- @@ -9428,7 +9466,7 @@ def __init__(self, arg=None, data=None, layout=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.Template constructor must be a dict or -an instance of plotly.graph_objs.layout.Template""" +an instance of :class:`plotly.graph_objs.layout.Template`""" ) # Handle skip_invalid @@ -9691,7 +9729,7 @@ def currentvalue(self): """ The 'currentvalue' property is an instance of Currentvalue that may be specified as: - - An instance of plotly.graph_objs.layout.slider.Currentvalue + - An instance of :class:`plotly.graph_objs.layout.slider.Currentvalue` - A dict of string/value properties that will be passed to the Currentvalue constructor @@ -9734,7 +9772,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.slider.Font + - An instance of :class:`plotly.graph_objs.layout.slider.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -9870,7 +9908,7 @@ def pad(self): The 'pad' property is an instance of Pad that may be specified as: - - An instance of plotly.graph_objs.layout.slider.Pad + - An instance of :class:`plotly.graph_objs.layout.slider.Pad` - A dict of string/value properties that will be passed to the Pad constructor @@ -9985,7 +10023,7 @@ def stepdefaults(self): The 'stepdefaults' property is an instance of Step that may be specified as: - - An instance of plotly.graph_objs.layout.slider.Step + - An instance of :class:`plotly.graph_objs.layout.slider.Step` - A dict of string/value properties that will be passed to the Step constructor @@ -10135,7 +10173,7 @@ def transition(self): """ The 'transition' property is an instance of Transition that may be specified as: - - An instance of plotly.graph_objs.layout.slider.Transition + - An instance of :class:`plotly.graph_objs.layout.slider.Transition` - A dict of string/value properties that will be passed to the Transition constructor @@ -10288,8 +10326,8 @@ def _prop_descriptions(self): Sets the width (in px) of the border enclosing the slider. currentvalue - plotly.graph_objects.layout.slider.Currentvalue - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Currentvalue + ` instance or dict with compatible properties font Sets the font of the slider step labels. len @@ -10315,7 +10353,8 @@ def _prop_descriptions(self): Set the padding of the slider component along each side. steps - A tuple of plotly.graph_objects.layout.slider.Step + A tuple of + :class:`plotly.graph_objects.layout.slider.Step` instances or dicts with compatible properties stepdefaults When used in a template (as @@ -10339,8 +10378,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). transition - plotly.graph_objects.layout.slider.Transition instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Transition` + instance or dict with compatible properties visible Determines whether or not the slider is visible. x @@ -10395,7 +10434,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Slider + an instance of :class:`plotly.graph_objs.layout.Slider` active Determines which button (by index starting from 0) is considered active. @@ -10410,8 +10449,8 @@ def __init__( Sets the width (in px) of the border enclosing the slider. currentvalue - plotly.graph_objects.layout.slider.Currentvalue - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Currentvalue + ` instance or dict with compatible properties font Sets the font of the slider step labels. len @@ -10437,7 +10476,8 @@ def __init__( Set the padding of the slider component along each side. steps - A tuple of plotly.graph_objects.layout.slider.Step + A tuple of + :class:`plotly.graph_objects.layout.slider.Step` instances or dicts with compatible properties stepdefaults When used in a template (as @@ -10461,8 +10501,8 @@ def __init__( tickwidth Sets the tick width (in px). transition - plotly.graph_objects.layout.slider.Transition instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Transition` + instance or dict with compatible properties visible Determines whether or not the slider is visible. x @@ -10499,7 +10539,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Slider constructor must be a dict or -an instance of plotly.graph_objs.layout.Slider""" +an instance of :class:`plotly.graph_objs.layout.Slider`""" ) # Handle skip_invalid @@ -10692,7 +10732,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.layout.shape.Line + - An instance of :class:`plotly.graph_objs.layout.shape.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -11137,8 +11177,8 @@ def _prop_descriptions(self): Specifies whether shapes are drawn below or above traces. line - plotly.graph_objects.layout.shape.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure @@ -11294,15 +11334,15 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Shape + an instance of :class:`plotly.graph_objs.layout.Shape` fillcolor Sets the color filling the shape's interior. layer Specifies whether shapes are drawn below or above traces. line - plotly.graph_objects.layout.shape.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any items the figure @@ -11445,7 +11485,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Shape constructor must be a dict or -an instance of plotly.graph_objs.layout.Shape""" +an instance of :class:`plotly.graph_objs.layout.Shape`""" ) # Handle skip_invalid @@ -11602,9 +11642,9 @@ def annotations(self): (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.scene.annotation.Ho - verlabel instance or dict with compatible - properties + :class:`plotly.graph_objects.layout.scene.annot + ation.Hoverlabel` instance or dict with + compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label @@ -11748,7 +11788,7 @@ def annotationdefaults(self): The 'annotationdefaults' property is an instance of Annotation that may be specified as: - - An instance of plotly.graph_objs.layout.scene.Annotation + - An instance of :class:`plotly.graph_objs.layout.scene.Annotation` - A dict of string/value properties that will be passed to the Annotation constructor @@ -11801,7 +11841,7 @@ def aspectratio(self): The 'aspectratio' property is an instance of Aspectratio that may be specified as: - - An instance of plotly.graph_objs.layout.scene.Aspectratio + - An instance of :class:`plotly.graph_objs.layout.scene.Aspectratio` - A dict of string/value properties that will be passed to the Aspectratio constructor @@ -11887,7 +11927,7 @@ def camera(self): """ The 'camera' property is an instance of Camera that may be specified as: - - An instance of plotly.graph_objs.layout.scene.Camera + - An instance of :class:`plotly.graph_objs.layout.scene.Camera` - A dict of string/value properties that will be passed to the Camera constructor @@ -11904,8 +11944,8 @@ def camera(self): vector. This vector determines the view point about the origin of this scene. projection - plotly.graph_objects.layout.scene.camera.Projec - tion instance or dict with compatible + :class:`plotly.graph_objects.layout.scene.camer + a.Projection` instance or dict with compatible properties up Sets the (x,y,z) components of the 'up' camera @@ -11931,7 +11971,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.layout.scene.Domain + - An instance of :class:`plotly.graph_objs.layout.scene.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -12030,7 +12070,7 @@ def xaxis(self): """ The 'xaxis' property is an instance of XAxis that may be specified as: - - An instance of plotly.graph_objs.layout.scene.XAxis + - An instance of :class:`plotly.graph_objs.layout.scene.XAxis` - A dict of string/value properties that will be passed to the XAxis constructor @@ -12250,9 +12290,9 @@ def xaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.scene.xa - xis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.xaxis.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.scene.xaxis.tickformatstopdefaults), sets @@ -12298,8 +12338,9 @@ def xaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.xaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.xaxis + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.scene.xaxis.title.font instead. Sets @@ -12342,7 +12383,7 @@ def yaxis(self): """ The 'yaxis' property is an instance of YAxis that may be specified as: - - An instance of plotly.graph_objs.layout.scene.YAxis + - An instance of :class:`plotly.graph_objs.layout.scene.YAxis` - A dict of string/value properties that will be passed to the YAxis constructor @@ -12562,9 +12603,9 @@ def yaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.scene.ya - xis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.yaxis.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.scene.yaxis.tickformatstopdefaults), sets @@ -12610,8 +12651,9 @@ def yaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.yaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.yaxis + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.scene.yaxis.title.font instead. Sets @@ -12654,7 +12696,7 @@ def zaxis(self): """ The 'zaxis' property is an instance of ZAxis that may be specified as: - - An instance of plotly.graph_objs.layout.scene.ZAxis + - An instance of :class:`plotly.graph_objs.layout.scene.ZAxis` - A dict of string/value properties that will be passed to the ZAxis constructor @@ -12874,9 +12916,9 @@ def zaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.scene.za - xis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.zaxis.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.scene.zaxis.tickformatstopdefaults), sets @@ -12922,8 +12964,9 @@ def zaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.zaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.zaxis + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.scene.zaxis.title.font instead. Sets @@ -12971,7 +13014,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ annotations - A tuple of plotly.graph_objects.layout.scene.Annotation + A tuple of + :class:`plotly.graph_objects.layout.scene.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -12994,11 +13038,11 @@ def _prop_descriptions(self): bgcolor camera - plotly.graph_objects.layout.scene.Camera instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Camera` + instance or dict with compatible properties domain - plotly.graph_objects.layout.scene.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Domain` + instance or dict with compatible properties dragmode Determines the mode of drag interactions for this scene. @@ -13009,14 +13053,14 @@ def _prop_descriptions(self): Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. xaxis - plotly.graph_objects.layout.scene.XAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.XAxis` + instance or dict with compatible properties yaxis - plotly.graph_objects.layout.scene.YAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.YAxis` + instance or dict with compatible properties zaxis - plotly.graph_objects.layout.scene.ZAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.ZAxis` + instance or dict with compatible properties """ def __init__( @@ -13044,9 +13088,10 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Scene + an instance of :class:`plotly.graph_objs.layout.Scene` annotations - A tuple of plotly.graph_objects.layout.scene.Annotation + A tuple of + :class:`plotly.graph_objects.layout.scene.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -13069,11 +13114,11 @@ def __init__( bgcolor camera - plotly.graph_objects.layout.scene.Camera instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Camera` + instance or dict with compatible properties domain - plotly.graph_objects.layout.scene.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Domain` + instance or dict with compatible properties dragmode Determines the mode of drag interactions for this scene. @@ -13084,14 +13129,14 @@ def __init__( Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. xaxis - plotly.graph_objects.layout.scene.XAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.XAxis` + instance or dict with compatible properties yaxis - plotly.graph_objects.layout.scene.YAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.YAxis` + instance or dict with compatible properties zaxis - plotly.graph_objects.layout.scene.ZAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.scene.ZAxis` + instance or dict with compatible properties Returns ------- @@ -13112,7 +13157,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Scene constructor must be a dict or -an instance of plotly.graph_objs.layout.Scene""" +an instance of :class:`plotly.graph_objs.layout.Scene`""" ) # Handle skip_invalid @@ -13551,7 +13596,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.RadialAxis + an instance of + :class:`plotly.graph_objs.layout.RadialAxis` domain Polar chart subplots are not supported yet. This key has currently no effect. @@ -13614,7 +13660,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.RadialAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.RadialAxis""" +an instance of :class:`plotly.graph_objs.layout.RadialAxis`""" ) # Handle skip_invalid @@ -13686,7 +13732,7 @@ def angularaxis(self): """ The 'angularaxis' property is an instance of AngularAxis that may be specified as: - - An instance of plotly.graph_objs.layout.polar.AngularAxis + - An instance of :class:`plotly.graph_objs.layout.polar.AngularAxis` - A dict of string/value properties that will be passed to the AngularAxis constructor @@ -13877,9 +13923,9 @@ def angularaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.an - gularaxis.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + polar.angularaxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.polar.angularaxis.tickformatstopdefaults), @@ -14064,7 +14110,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.layout.polar.Domain + - An instance of :class:`plotly.graph_objs.layout.polar.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -14148,7 +14194,7 @@ def radialaxis(self): """ The 'radialaxis' property is an instance of RadialAxis that may be specified as: - - An instance of plotly.graph_objs.layout.polar.RadialAxis + - An instance of :class:`plotly.graph_objs.layout.polar.RadialAxis` - A dict of string/value properties that will be passed to the RadialAxis constructor @@ -14360,9 +14406,9 @@ def radialaxis(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.ra - dialaxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + polar.radialaxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.polar.radialaxis.tickformatstopdefaults), @@ -14409,8 +14455,9 @@ def radialaxis(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.polar.radialaxis.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.radia + laxis.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.polar.radialaxis.title.font instead. @@ -14504,8 +14551,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ angularaxis - plotly.graph_objects.layout.polar.AngularAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.AngularAxis` + instance or dict with compatible properties bargap Sets the gap between bars of adjacent location coordinates. Values are unitless, they represent @@ -14520,8 +14567,8 @@ def _prop_descriptions(self): bgcolor Set the background color of the subplot domain - plotly.graph_objects.layout.polar.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Domain` + instance or dict with compatible properties gridshape Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as @@ -14534,8 +14581,8 @@ def _prop_descriptions(self): Sets the fraction of the radius to cut out of the polar subplot. radialaxis - plotly.graph_objects.layout.polar.RadialAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.RadialAxis` + instance or dict with compatible properties sector Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the @@ -14569,10 +14616,10 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Polar + an instance of :class:`plotly.graph_objs.layout.Polar` angularaxis - plotly.graph_objects.layout.polar.AngularAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.AngularAxis` + instance or dict with compatible properties bargap Sets the gap between bars of adjacent location coordinates. Values are unitless, they represent @@ -14587,8 +14634,8 @@ def __init__( bgcolor Set the background color of the subplot domain - plotly.graph_objects.layout.polar.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Domain` + instance or dict with compatible properties gridshape Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as @@ -14601,8 +14648,8 @@ def __init__( Sets the fraction of the radius to cut out of the polar subplot. radialaxis - plotly.graph_objects.layout.polar.RadialAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.RadialAxis` + instance or dict with compatible properties sector Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the @@ -14632,7 +14679,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Polar constructor must be a dict or -an instance of plotly.graph_objs.layout.Polar""" +an instance of :class:`plotly.graph_objs.layout.Polar`""" ) # Handle skip_invalid @@ -14959,7 +15006,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Modebar + an instance of + :class:`plotly.graph_objs.layout.Modebar` activecolor Sets the color of the active or hovered on icons in the modebar. @@ -14994,7 +15042,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Modebar constructor must be a dict or -an instance of plotly.graph_objs.layout.Modebar""" +an instance of :class:`plotly.graph_objs.layout.Modebar`""" ) # Handle skip_invalid @@ -15211,7 +15259,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Margin + an instance of :class:`plotly.graph_objs.layout.Margin` autoexpand Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and @@ -15248,7 +15296,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Margin constructor must be a dict or -an instance of plotly.graph_objs.layout.Margin""" +an instance of :class:`plotly.graph_objs.layout.Margin`""" ) # Handle skip_invalid @@ -15351,7 +15399,7 @@ def center(self): """ The 'center' property is an instance of Center that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.Center + - An instance of :class:`plotly.graph_objs.layout.mapbox.Center` - A dict of string/value properties that will be passed to the Center constructor @@ -15381,7 +15429,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.Domain + - An instance of :class:`plotly.graph_objs.layout.mapbox.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -15430,8 +15478,9 @@ def layers(self): set to '', the layer will be inserted above every existing layer. circle - plotly.graph_objects.layout.mapbox.layer.Circle - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Circle` instance or dict with compatible + properties color Sets the primary layer color. If `type` is "circle", color corresponds to the circle color @@ -15449,11 +15498,13 @@ def layers(self): right, bottom left. Only has an effect for "image" `sourcetype`. fill - plotly.graph_objects.layout.mapbox.layer.Fill - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Fill` instance or dict with compatible + properties line - plotly.graph_objects.layout.mapbox.layer.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Line` instance or dict with compatible + properties maxzoom Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to @@ -15504,8 +15555,9 @@ def layers(self): Sets the source type for this layer, that is the type of the layer data. symbol - plotly.graph_objects.layout.mapbox.layer.Symbol - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Symbol` instance or dict with compatible + properties templateitemname Used to refer to a named item in this array in the template. Named items from the template @@ -15553,7 +15605,7 @@ def layerdefaults(self): The 'layerdefaults' property is an instance of Layer that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.Layer + - An instance of :class:`plotly.graph_objs.layout.mapbox.Layer` - A dict of string/value properties that will be passed to the Layer constructor @@ -15692,13 +15744,14 @@ def _prop_descriptions(self): Sets the bearing angle of the map in degrees counter- clockwise from North (mapbox.bearing). center - plotly.graph_objects.layout.mapbox.Center instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Center` + instance or dict with compatible properties domain - plotly.graph_objects.layout.mapbox.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Domain` + instance or dict with compatible properties layers - A tuple of plotly.graph_objects.layout.mapbox.Layer + A tuple of + :class:`plotly.graph_objects.layout.mapbox.Layer` instances or dicts with compatible properties layerdefaults When used in a template (as @@ -15764,7 +15817,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Mapbox + an instance of :class:`plotly.graph_objs.layout.Mapbox` accesstoken Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set @@ -15777,13 +15830,14 @@ def __init__( Sets the bearing angle of the map in degrees counter- clockwise from North (mapbox.bearing). center - plotly.graph_objects.layout.mapbox.Center instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Center` + instance or dict with compatible properties domain - plotly.graph_objects.layout.mapbox.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Domain` + instance or dict with compatible properties layers - A tuple of plotly.graph_objects.layout.mapbox.Layer + A tuple of + :class:`plotly.graph_objects.layout.mapbox.Layer` instances or dicts with compatible properties layerdefaults When used in a template (as @@ -15845,7 +15899,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Mapbox constructor must be a dict or -an instance of plotly.graph_objs.layout.Mapbox""" +an instance of :class:`plotly.graph_objs.layout.Mapbox`""" ) # Handle skip_invalid @@ -16055,7 +16109,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.legend.Font + - An instance of :class:`plotly.graph_objs.layout.legend.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -16190,7 +16244,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.legend.Title + - An instance of :class:`plotly.graph_objs.layout.legend.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -16448,8 +16502,8 @@ def _prop_descriptions(self): orientation Sets the orientation of the legend. title - plotly.graph_objects.layout.legend.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.legend.Title` + instance or dict with compatible properties tracegroupgap Sets the amount of vertical space (in px) between legend groups. @@ -16526,7 +16580,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Legend + an instance of :class:`plotly.graph_objs.layout.Legend` bgcolor Sets the legend background color. Defaults to `layout.paper_bgcolor`. @@ -16556,8 +16610,8 @@ def __init__( orientation Sets the orientation of the legend. title - plotly.graph_objects.layout.legend.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.legend.Title` + instance or dict with compatible properties tracegroupgap Sets the amount of vertical space (in px) between legend groups. @@ -16623,7 +16677,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Legend constructor must be a dict or -an instance of plotly.graph_objs.layout.Legend""" +an instance of :class:`plotly.graph_objs.layout.Legend`""" ) # Handle skip_invalid @@ -17164,7 +17218,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Image + an instance of :class:`plotly.graph_objs.layout.Image` layer Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, @@ -17254,7 +17308,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Image constructor must be a dict or -an instance of plotly.graph_objs.layout.Image""" +an instance of :class:`plotly.graph_objs.layout.Image`""" ) # Handle skip_invalid @@ -17484,7 +17538,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.layout.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -17595,7 +17649,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Hoverlabel + an instance of + :class:`plotly.graph_objs.layout.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -17635,7 +17690,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.layout.Hoverlabel""" +an instance of :class:`plotly.graph_objs.layout.Hoverlabel`""" ) # Handle skip_invalid @@ -17715,7 +17770,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.layout.grid.Domain + - An instance of :class:`plotly.graph_objs.layout.grid.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -18015,8 +18070,8 @@ def _prop_descriptions(self): to have a different length, if you want to leave a row at the end for non-cartesian subplots. domain - plotly.graph_objects.layout.grid.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.grid.Domain` + instance or dict with compatible properties pattern If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults @@ -18103,7 +18158,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Grid + an instance of :class:`plotly.graph_objs.layout.Grid` columns The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used @@ -18112,8 +18167,8 @@ def __init__( to have a different length, if you want to leave a row at the end for non-cartesian subplots. domain - plotly.graph_objects.layout.grid.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.grid.Domain` + instance or dict with compatible properties pattern If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults @@ -18194,7 +18249,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Grid constructor must be a dict or -an instance of plotly.graph_objs.layout.Grid""" +an instance of :class:`plotly.graph_objs.layout.Grid`""" ) # Handle skip_invalid @@ -18328,7 +18383,7 @@ def center(self): """ The 'center' property is an instance of Center that may be specified as: - - An instance of plotly.graph_objs.layout.geo.Center + - An instance of :class:`plotly.graph_objs.layout.geo.Center` - A dict of string/value properties that will be passed to the Center constructor @@ -18521,7 +18576,7 @@ def domain(self): """ The 'domain' property is an instance of Domain that may be specified as: - - An instance of plotly.graph_objs.layout.geo.Domain + - An instance of :class:`plotly.graph_objs.layout.geo.Domain` - A dict of string/value properties that will be passed to the Domain constructor @@ -18801,7 +18856,7 @@ def lataxis(self): """ The 'lataxis' property is an instance of Lataxis that may be specified as: - - An instance of plotly.graph_objs.layout.geo.Lataxis + - An instance of :class:`plotly.graph_objs.layout.geo.Lataxis` - A dict of string/value properties that will be passed to the Lataxis constructor @@ -18841,7 +18896,7 @@ def lonaxis(self): """ The 'lonaxis' property is an instance of Lonaxis that may be specified as: - - An instance of plotly.graph_objs.layout.geo.Lonaxis + - An instance of :class:`plotly.graph_objs.layout.geo.Lonaxis` - A dict of string/value properties that will be passed to the Lonaxis constructor @@ -18940,7 +18995,7 @@ def projection(self): """ The 'projection' property is an instance of Projection that may be specified as: - - An instance of plotly.graph_objs.layout.geo.Projection + - An instance of :class:`plotly.graph_objs.layout.geo.Projection` - A dict of string/value properties that will be passed to the Projection constructor @@ -18951,8 +19006,8 @@ def projection(self): parallels (tangent, secant) where the cone intersects the sphere. rotation - plotly.graph_objects.layout.geo.projection.Rota - tion instance or dict with compatible + :class:`plotly.graph_objects.layout.geo.project + ion.Rotation` instance or dict with compatible properties scale Zooms in or out on the map view. A scale of 1 @@ -19389,8 +19444,8 @@ def _prop_descriptions(self): bgcolor Set the background color of the map center - plotly.graph_objects.layout.geo.Center instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.geo.Center` + instance or dict with compatible properties coastlinecolor Sets the coastline color. coastlinewidth @@ -19400,8 +19455,8 @@ def _prop_descriptions(self): countrywidth Sets line width (in px) of the country boundaries. domain - plotly.graph_objects.layout.geo.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.geo.Domain` + instance or dict with compatible properties fitbounds Determines if this subplot's view settings are auto- computed to fit trace data. On scoped maps, setting @@ -19427,16 +19482,16 @@ def _prop_descriptions(self): landcolor Sets the land mass color. lataxis - plotly.graph_objects.layout.geo.Lataxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lataxis` + instance or dict with compatible properties lonaxis - plotly.graph_objects.layout.geo.Lonaxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lonaxis` + instance or dict with compatible properties oceancolor Sets the ocean color projection - plotly.graph_objects.layout.geo.Projection instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Projection` + instance or dict with compatible properties resolution Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of @@ -19521,12 +19576,12 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Geo + an instance of :class:`plotly.graph_objs.layout.Geo` bgcolor Set the background color of the map center - plotly.graph_objects.layout.geo.Center instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.geo.Center` + instance or dict with compatible properties coastlinecolor Sets the coastline color. coastlinewidth @@ -19536,8 +19591,8 @@ def __init__( countrywidth Sets line width (in px) of the country boundaries. domain - plotly.graph_objects.layout.geo.Domain instance or dict - with compatible properties + :class:`plotly.graph_objects.layout.geo.Domain` + instance or dict with compatible properties fitbounds Determines if this subplot's view settings are auto- computed to fit trace data. On scoped maps, setting @@ -19563,16 +19618,16 @@ def __init__( landcolor Sets the land mass color. lataxis - plotly.graph_objects.layout.geo.Lataxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lataxis` + instance or dict with compatible properties lonaxis - plotly.graph_objects.layout.geo.Lonaxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lonaxis` + instance or dict with compatible properties oceancolor Sets the ocean color projection - plotly.graph_objects.layout.geo.Projection instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Projection` + instance or dict with compatible properties resolution Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of @@ -19631,7 +19686,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Geo constructor must be a dict or -an instance of plotly.graph_objs.layout.Geo""" +an instance of :class:`plotly.graph_objs.layout.Geo`""" ) # Handle skip_invalid @@ -19907,7 +19962,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Font + an instance of :class:`plotly.graph_objs.layout.Font` color family @@ -19946,7 +20001,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.Font""" +an instance of :class:`plotly.graph_objs.layout.Font`""" ) # Handle skip_invalid @@ -20156,7 +20211,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Colorscale + an instance of + :class:`plotly.graph_objs.layout.Colorscale` diverging Sets the default diverging colorscale. Note that `autocolorscale` must be true for this attribute to @@ -20189,7 +20245,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Colorscale constructor must be a dict or -an instance of plotly.graph_objs.layout.Colorscale""" +an instance of :class:`plotly.graph_objs.layout.Colorscale`""" ) # Handle skip_invalid @@ -20352,7 +20408,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.layout.coloraxis.ColorBar + - An instance of :class:`plotly.graph_objs.layout.coloraxis.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -20484,9 +20540,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.coloraxi - s.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + coloraxis.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.coloraxis.colorbar.tickformatstopdefaults), @@ -20533,8 +20589,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.coloraxis.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.layout.coloraxis.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -20714,8 +20770,8 @@ def _prop_descriptions(self): have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well. colorbar - plotly.graph_objects.layout.coloraxis.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.coloraxis.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -20758,7 +20814,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Coloraxis + an instance of + :class:`plotly.graph_objs.layout.Coloraxis` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -20786,8 +20843,8 @@ def __init__( have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well. colorbar - plotly.graph_objects.layout.coloraxis.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.coloraxis.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, @@ -20827,7 +20884,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Coloraxis constructor must be a dict or -an instance of plotly.graph_objs.layout.Coloraxis""" +an instance of :class:`plotly.graph_objs.layout.Coloraxis`""" ) # Handle skip_invalid @@ -21383,7 +21440,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.annotation.Font + - An instance of :class:`plotly.graph_objs.layout.annotation.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -21447,7 +21504,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.layout.annotation.Hoverlabel + - An instance of :class:`plotly.graph_objs.layout.annotation.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -22141,8 +22198,8 @@ def _prop_descriptions(self): (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.annotation.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. @@ -22338,7 +22395,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Annotation + an instance of + :class:`plotly.graph_objs.layout.Annotation` align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more @@ -22427,8 +22485,8 @@ def __init__( (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.annotation.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. @@ -22587,7 +22645,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.Annotation constructor must be a dict or -an instance of plotly.graph_objs.layout.Annotation""" +an instance of :class:`plotly.graph_objs.layout.Annotation`""" ) # Handle skip_invalid @@ -23090,7 +23148,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.AngularAxis + an instance of + :class:`plotly.graph_objs.layout.AngularAxis` domain Polar chart subplots are not supported yet. This key has currently no effect. @@ -23149,7 +23208,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.AngularAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.AngularAxis""" +an instance of :class:`plotly.graph_objs.layout.AngularAxis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/annotation/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/annotation/__init__.py index e63f4020e63..3b32349efd1 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/annotation/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/annotation/__init__.py @@ -136,7 +136,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.annotation.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.layout.annotation.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -206,7 +206,7 @@ def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.annotation.Hoverlabel + :class:`plotly.graph_objs.layout.annotation.Hoverlabel` bgcolor Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or @@ -239,7 +239,7 @@ def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs """\ The first argument to the plotly.graph_objs.layout.annotation.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.layout.annotation.Hoverlabel""" +an instance of :class:`plotly.graph_objs.layout.annotation.Hoverlabel`""" ) # Handle skip_invalid @@ -427,7 +427,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.annotation.Font + an instance of + :class:`plotly.graph_objs.layout.annotation.Font` color family @@ -466,7 +467,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.annotation.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.annotation.Font""" +an instance of :class:`plotly.graph_objs.layout.annotation.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py index e571c58805f..4a24b912ca7 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.annotation.hoverlabel.Font + an instance of :class:`plotly.graph_objs.layout.annotat + ion.hoverlabel.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.annotation.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.annotation.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.layout.annotation.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/__init__.py index 820a17d36f9..4cd2ac05d04 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/__init__.py @@ -625,7 +625,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.coloraxis.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -759,7 +759,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -997,7 +997,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.coloraxis.colorbar.Title + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1041,7 +1041,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.coloraxis.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1350,9 +1350,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.coloraxis.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.coloraxi + s.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.colo raxis.colorbar.tickformatstopdefaults), sets the @@ -1392,8 +1392,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.coloraxis.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.coloraxis.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use layout.coloraxis.colorbar.title.font instead. Sets this @@ -1489,7 +1489,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.coloraxis.ColorBar + :class:`plotly.graph_objs.layout.coloraxis.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -1602,9 +1602,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.coloraxis.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.coloraxi + s.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.colo raxis.colorbar.tickformatstopdefaults), sets the @@ -1644,8 +1644,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.coloraxis.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.coloraxis.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use layout.coloraxis.colorbar.title.font instead. Sets this @@ -1698,7 +1698,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.coloraxis.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.layout.coloraxis.ColorBar""" +an instance of :class:`plotly.graph_objs.layout.coloraxis.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py index 3dac18c1335..fc5f5bbec40 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.coloraxis.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.coloraxis.colorbar.Title + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.coloraxis.colorbar.Title""" +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.coloraxis.color - bar.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.coloraxis.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.coloraxis.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py index 3b1724c05c4..4a84c39bd76 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.coloraxis.colorbar.title.Font + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.coloraxis.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/geo/__init__.py index eaa0771030e..7faff27c96d 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/geo/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/geo/__init__.py @@ -37,7 +37,7 @@ def rotation(self): """ The 'rotation' property is an instance of Rotation that may be specified as: - - An instance of plotly.graph_objs.layout.geo.projection.Rotation + - An instance of :class:`plotly.graph_objs.layout.geo.projection.Rotation` - A dict of string/value properties that will be passed to the Rotation constructor @@ -127,8 +127,8 @@ def _prop_descriptions(self): For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere. rotation - plotly.graph_objects.layout.geo.projection.Rotation - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.projection.Rota + tion` instance or dict with compatible properties scale Zooms in or out on the map view. A scale of 1 corresponds to the largest zoom level that fits the @@ -147,13 +147,14 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Projection + an instance of + :class:`plotly.graph_objs.layout.geo.Projection` parallels For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere. rotation - plotly.graph_objects.layout.geo.projection.Rotation - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.projection.Rota + tion` instance or dict with compatible properties scale Zooms in or out on the map view. A scale of 1 corresponds to the largest zoom level that fits the @@ -180,7 +181,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.geo.Projection constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Projection""" +an instance of :class:`plotly.graph_objs.layout.geo.Projection`""" ) # Handle skip_invalid @@ -433,7 +434,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Lonaxis + an instance of + :class:`plotly.graph_objs.layout.geo.Lonaxis` dtick Sets the graticule's longitude/latitude tick step. gridcolor @@ -467,7 +469,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.geo.Lonaxis constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Lonaxis""" +an instance of :class:`plotly.graph_objs.layout.geo.Lonaxis`""" ) # Handle skip_invalid @@ -726,7 +728,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Lataxis + an instance of + :class:`plotly.graph_objs.layout.geo.Lataxis` dtick Sets the graticule's longitude/latitude tick step. gridcolor @@ -760,7 +763,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.geo.Lataxis constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Lataxis""" +an instance of :class:`plotly.graph_objs.layout.geo.Lataxis`""" ) # Handle skip_invalid @@ -961,7 +964,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Domain + an instance of + :class:`plotly.graph_objs.layout.geo.Domain` column If there is a layout grid, use the domain for this column in the grid for this geo subplot . Note that geo @@ -1006,7 +1010,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.geo.Domain constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Domain""" +an instance of :class:`plotly.graph_objs.layout.geo.Domain`""" ) # Handle skip_invalid @@ -1125,7 +1129,8 @@ def __init__(self, arg=None, lat=None, lon=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Center + an instance of + :class:`plotly.graph_objs.layout.geo.Center` lat Sets the latitude of the map's center. For all projection types, the map's latitude center lies at the @@ -1155,7 +1160,7 @@ def __init__(self, arg=None, lat=None, lon=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.geo.Center constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Center""" +an instance of :class:`plotly.graph_objs.layout.geo.Center`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/projection/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/geo/projection/__init__.py index a903ad4a960..7a3eb20528f 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/geo/projection/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/geo/projection/__init__.py @@ -95,8 +95,8 @@ def __init__(self, arg=None, lat=None, lon=None, roll=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.geo.projection.Rotation + an instance of :class:`plotly.graph_objs.layout.geo.pro + jection.Rotation` lat Rotates the map along meridians (in degrees North). lon @@ -125,7 +125,7 @@ def __init__(self, arg=None, lat=None, lon=None, roll=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.geo.projection.Rotation constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.projection.Rotation""" +an instance of :class:`plotly.graph_objs.layout.geo.projection.Rotation`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/grid/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/grid/__init__.py index 6a50ee5da27..f4569255f74 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/grid/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/grid/__init__.py @@ -87,7 +87,8 @@ def __init__(self, arg=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.grid.Domain + an instance of + :class:`plotly.graph_objs.layout.grid.Domain` x Sets the horizontal domain of this grid subplot (in plot fraction). The first and last cells end exactly at @@ -116,7 +117,7 @@ def __init__(self, arg=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.grid.Domain constructor must be a dict or -an instance of plotly.graph_objs.layout.grid.Domain""" +an instance of :class:`plotly.graph_objs.layout.grid.Domain`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/__init__.py index db9888620a5..77900291d05 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/__init__.py @@ -152,7 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.layout.hoverlabel.Font` color family @@ -191,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.layout.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/legend/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/legend/__init__.py index 83148f1f81f..7a190b7f914 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/legend/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/legend/__init__.py @@ -13,7 +13,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.legend.title.Font + - An instance of :class:`plotly.graph_objs.layout.legend.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -126,7 +126,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.legend.Title + an instance of + :class:`plotly.graph_objs.layout.legend.Title` font Sets this legend's title font. side @@ -157,7 +158,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.legend.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.legend.Title""" +an instance of :class:`plotly.graph_objs.layout.legend.Title`""" ) # Handle skip_invalid @@ -345,7 +346,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.legend.Font + an instance of + :class:`plotly.graph_objs.layout.legend.Font` color family @@ -384,7 +386,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.legend.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.legend.Font""" +an instance of :class:`plotly.graph_objs.layout.legend.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/legend/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/legend/title/__init__.py index cd70d60c69e..52f8678c4f4 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/legend/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/legend/title/__init__.py @@ -152,7 +152,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.legend.title.Font + :class:`plotly.graph_objs.layout.legend.title.Font` color family @@ -191,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.legend.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.legend.title.Font""" +an instance of :class:`plotly.graph_objs.layout.legend.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/__init__.py index 2347b6e6e4f..cd3b4d2f36f 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/__init__.py @@ -34,7 +34,7 @@ def circle(self): """ The 'circle' property is an instance of Circle that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.layer.Circle + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Circle` - A dict of string/value properties that will be passed to the Circle constructor @@ -149,7 +149,7 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.layer.Fill + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Fill` - A dict of string/value properties that will be passed to the Fill constructor @@ -177,7 +177,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.layer.Line + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -399,7 +399,7 @@ def symbol(self): """ The 'symbol' property is an instance of Symbol that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.layer.Symbol + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Symbol` - A dict of string/value properties that will be passed to the Symbol constructor @@ -536,8 +536,8 @@ def _prop_descriptions(self): layer with the specified ID. If omitted or set to '', the layer will be inserted above every existing layer. circle - plotly.graph_objects.layout.mapbox.layer.Circle - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Circle + ` instance or dict with compatible properties color Sets the primary layer color. If `type` is "circle", color corresponds to the circle color @@ -555,11 +555,11 @@ def _prop_descriptions(self): bottom left. Only has an effect for "image" `sourcetype`. fill - plotly.graph_objects.layout.mapbox.layer.Fill instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Fill` + instance or dict with compatible properties line - plotly.graph_objects.layout.mapbox.layer.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Line` + instance or dict with compatible properties maxzoom Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the @@ -605,8 +605,8 @@ def _prop_descriptions(self): Sets the source type for this layer, that is the type of the layer data. symbol - plotly.graph_objects.layout.mapbox.layer.Symbol - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Symbol + ` instance or dict with compatible properties templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created @@ -661,14 +661,15 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.mapbox.Layer + an instance of + :class:`plotly.graph_objs.layout.mapbox.Layer` below Determines if the layer will be inserted before the layer with the specified ID. If omitted or set to '', the layer will be inserted above every existing layer. circle - plotly.graph_objects.layout.mapbox.layer.Circle - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Circle + ` instance or dict with compatible properties color Sets the primary layer color. If `type` is "circle", color corresponds to the circle color @@ -686,11 +687,11 @@ def __init__( bottom left. Only has an effect for "image" `sourcetype`. fill - plotly.graph_objects.layout.mapbox.layer.Fill instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Fill` + instance or dict with compatible properties line - plotly.graph_objects.layout.mapbox.layer.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Line` + instance or dict with compatible properties maxzoom Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the @@ -736,8 +737,8 @@ def __init__( Sets the source type for this layer, that is the type of the layer data. symbol - plotly.graph_objects.layout.mapbox.layer.Symbol - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.layer.Symbol + ` instance or dict with compatible properties templateitemname Used to refer to a named item in this array in the template. Named items from the template will be created @@ -780,7 +781,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.mapbox.Layer constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.Layer""" +an instance of :class:`plotly.graph_objs.layout.mapbox.Layer`""" ) # Handle skip_invalid @@ -999,7 +1000,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.mapbox.Domain + an instance of + :class:`plotly.graph_objs.layout.mapbox.Domain` column If there is a layout grid, use the domain for this column in the grid for this mapbox subplot . @@ -1032,7 +1034,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.mapbox.Domain constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.Domain""" +an instance of :class:`plotly.graph_objs.layout.mapbox.Domain`""" ) # Handle skip_invalid @@ -1143,7 +1145,8 @@ def __init__(self, arg=None, lat=None, lon=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.mapbox.Center + an instance of + :class:`plotly.graph_objs.layout.mapbox.Center` lat Sets the latitude of the center of the map (in degrees North). @@ -1170,7 +1173,7 @@ def __init__(self, arg=None, lat=None, lon=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.mapbox.Center constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.Center""" +an instance of :class:`plotly.graph_objs.layout.mapbox.Center`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/__init__.py index c4a6a4e3e59..636cf70269e 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/__init__.py @@ -105,7 +105,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.layout.mapbox.layer.symbol.Textfont + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.symbol.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -221,7 +221,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.mapbox.layer.Symbol + :class:`plotly.graph_objs.layout.mapbox.layer.Symbol` icon Sets the symbol icon image (mapbox.layer.layout.icon- image). Full list: https://www.mapbox.com/maki-icons/ @@ -266,7 +266,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.mapbox.layer.Symbol constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Symbol""" +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Symbol`""" ) # Handle skip_invalid @@ -409,7 +409,7 @@ def __init__(self, arg=None, dash=None, dashsrc=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.mapbox.layer.Line + :class:`plotly.graph_objs.layout.mapbox.layer.Line` dash Sets the length of dashes and gaps (mapbox.layer.paint.line-dasharray). Has an effect only @@ -439,7 +439,7 @@ def __init__(self, arg=None, dash=None, dashsrc=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.mapbox.layer.Line constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Line""" +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Line`""" ) # Handle skip_invalid @@ -566,7 +566,7 @@ def __init__(self, arg=None, outlinecolor=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.mapbox.layer.Fill + :class:`plotly.graph_objs.layout.mapbox.layer.Fill` outlinecolor Sets the fill outline color (mapbox.layer.paint.fill- outline-color). Has an effect only when `type` is set @@ -591,7 +591,7 @@ def __init__(self, arg=None, outlinecolor=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.mapbox.layer.Fill constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Fill""" +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Fill`""" ) # Handle skip_invalid @@ -673,7 +673,7 @@ def __init__(self, arg=None, radius=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.mapbox.layer.Circle + :class:`plotly.graph_objs.layout.mapbox.layer.Circle` radius Sets the circle radius (mapbox.layer.paint.circle- radius). Has an effect only when `type` is set to @@ -698,7 +698,7 @@ def __init__(self, arg=None, radius=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.mapbox.layer.Circle constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Circle""" +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Circle`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py index 2d8873dfbbc..b8899e36463 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py @@ -153,8 +153,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.mapbox.layer.symbol.Textfont + an instance of :class:`plotly.graph_objs.layout.mapbox. + layer.symbol.Textfont` color family @@ -193,7 +193,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.mapbox.layer.symbol.Textfont constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.symbol.Textfont""" +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.symbol.Textfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/polar/__init__.py index f4ef6a9765f..ee2831a2d47 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/polar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/polar/__init__.py @@ -870,7 +870,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.polar.radialaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1003,7 +1003,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.polar.radialaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1241,7 +1241,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.polar.radialaxis.Title + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1280,7 +1280,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.polar.radialaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1576,9 +1576,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.radialaxis - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.polar.ra + dialaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.pola r.radialaxis.tickformatstopdefaults), sets the default @@ -1618,8 +1618,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.polar.radialaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.radialaxis.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use layout.polar.radialaxis.title.font instead. Sets this @@ -1703,7 +1703,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.polar.RadialAxis + :class:`plotly.graph_objs.layout.polar.RadialAxis` angle Sets the angle (in degrees) from which the radial axis is drawn. Note that by default, radial axis line on the @@ -1887,9 +1887,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.radialaxis - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.polar.ra + dialaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.pola r.radialaxis.tickformatstopdefaults), sets the default @@ -1929,8 +1929,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.polar.radialaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.radialaxis.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use layout.polar.radialaxis.title.font instead. Sets this @@ -1969,7 +1969,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.polar.RadialAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.RadialAxis""" +an instance of :class:`plotly.graph_objs.layout.polar.RadialAxis`""" ) # Handle skip_invalid @@ -2285,7 +2285,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.polar.Domain + an instance of + :class:`plotly.graph_objs.layout.polar.Domain` column If there is a layout grid, use the domain for this column in the grid for this polar subplot . @@ -2318,7 +2319,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.polar.Domain constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.Domain""" +an instance of :class:`plotly.graph_objs.layout.polar.Domain`""" ) # Handle skip_invalid @@ -3166,7 +3167,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.polar.angularaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -3299,7 +3300,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.polar.angularaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -3770,9 +3771,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.angularaxi - s.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.polar.an + gularaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.pola r.angularaxis.tickformatstopdefaults), sets the default @@ -3882,7 +3883,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.polar.AngularAxis + :class:`plotly.graph_objs.layout.polar.AngularAxis` categoryarray Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to @@ -4046,9 +4047,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.angularaxi - s.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.polar.an + gularaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.pola r.angularaxis.tickformatstopdefaults), sets the default @@ -4119,7 +4120,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.polar.AngularAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.AngularAxis""" +an instance of :class:`plotly.graph_objs.layout.polar.AngularAxis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/__init__.py index 67c347506d6..88c1d18b1fb 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/__init__.py @@ -187,8 +187,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.polar.angularax - is.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.polar.a + ngularaxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -239,7 +239,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.angularaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -439,8 +439,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.angularaxis.Tickfont + an instance of :class:`plotly.graph_objs.layout.polar.a + ngularaxis.Tickfont` color family @@ -479,7 +479,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.angularaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/__init__.py index 2b5d9da9bee..3735a4c7af4 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.polar.radialaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -103,8 +103,8 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.radialaxis.Title + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.polar.radialaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.polar.radialaxi - s.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -607,8 +607,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.radialaxis.Tickfont + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py index f6ce01a46b4..e07e3259f6c 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.radialaxis.title.Font + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.polar.radialaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/__init__.py index 3348efe29c7..795f702bd7d 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/__init__.py @@ -1042,7 +1042,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.scene.zaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1176,7 +1176,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.scene.zaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1414,7 +1414,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.scene.zaxis.Title + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1452,7 +1452,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.zaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1837,9 +1837,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.scene.zaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.scene.za + xis.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.scen e.zaxis.tickformatstopdefaults), sets the default @@ -1879,8 +1879,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.zaxis.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.zaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.scene.zaxis.title.font instead. Sets this axis' title font. Note that the @@ -1973,7 +1973,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.ZAxis + an instance of + :class:`plotly.graph_objs.layout.scene.ZAxis` autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` @@ -2166,9 +2167,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.scene.zaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.scene.za + xis.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.scen e.zaxis.tickformatstopdefaults), sets the default @@ -2208,8 +2209,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.zaxis.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.zaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.scene.zaxis.title.font instead. Sets this axis' title font. Note that the @@ -2251,7 +2252,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.ZAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.ZAxis""" +an instance of :class:`plotly.graph_objs.layout.scene.ZAxis`""" ) # Handle skip_invalid @@ -3493,7 +3494,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.scene.yaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -3627,7 +3628,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.scene.yaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -3865,7 +3866,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.scene.yaxis.Title + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -3903,7 +3904,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.yaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -4288,9 +4289,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.scene.yaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.scene.ya + xis.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.scen e.yaxis.tickformatstopdefaults), sets the default @@ -4330,8 +4331,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.yaxis.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.yaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.scene.yaxis.title.font instead. Sets this axis' title font. Note that the @@ -4424,7 +4425,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.YAxis + an instance of + :class:`plotly.graph_objs.layout.scene.YAxis` autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` @@ -4617,9 +4619,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.scene.yaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.scene.ya + xis.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.scen e.yaxis.tickformatstopdefaults), sets the default @@ -4659,8 +4661,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.yaxis.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.yaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.scene.yaxis.title.font instead. Sets this axis' title font. Note that the @@ -4702,7 +4704,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.YAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.YAxis""" +an instance of :class:`plotly.graph_objs.layout.scene.YAxis`""" ) # Handle skip_invalid @@ -5944,7 +5946,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.scene.xaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -6078,7 +6080,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.scene.xaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -6316,7 +6318,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.scene.xaxis.Title + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -6354,7 +6356,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.xaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -6739,9 +6741,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.scene.xaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.scene.xa + xis.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.scen e.xaxis.tickformatstopdefaults), sets the default @@ -6781,8 +6783,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.xaxis.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.xaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.scene.xaxis.title.font instead. Sets this axis' title font. Note that the @@ -6875,7 +6877,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.XAxis + an instance of + :class:`plotly.graph_objs.layout.scene.XAxis` autorange Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` @@ -7068,9 +7071,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.layout.scene.xaxis.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout.scene.xa + xis.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.layout.scen e.xaxis.tickformatstopdefaults), sets the default @@ -7110,8 +7113,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.xaxis.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.xaxis.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.scene.xaxis.title.font instead. Sets this axis' title font. Note that the @@ -7153,7 +7156,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.XAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.XAxis""" +an instance of :class:`plotly.graph_objs.layout.scene.XAxis`""" ) # Handle skip_invalid @@ -7486,7 +7489,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.Domain + an instance of + :class:`plotly.graph_objs.layout.scene.Domain` column If there is a layout grid, use the domain for this column in the grid for this scene subplot . @@ -7519,7 +7523,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.Domain constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Domain""" +an instance of :class:`plotly.graph_objs.layout.scene.Domain`""" ) # Handle skip_invalid @@ -7574,7 +7578,7 @@ def center(self): The 'center' property is an instance of Center that may be specified as: - - An instance of plotly.graph_objs.layout.scene.camera.Center + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Center` - A dict of string/value properties that will be passed to the Center constructor @@ -7607,7 +7611,7 @@ def eye(self): The 'eye' property is an instance of Eye that may be specified as: - - An instance of plotly.graph_objs.layout.scene.camera.Eye + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Eye` - A dict of string/value properties that will be passed to the Eye constructor @@ -7636,7 +7640,7 @@ def projection(self): """ The 'projection' property is an instance of Projection that may be specified as: - - An instance of plotly.graph_objs.layout.scene.camera.Projection + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Projection` - A dict of string/value properties that will be passed to the Projection constructor @@ -7669,7 +7673,7 @@ def up(self): The 'up' property is an instance of Up that may be specified as: - - An instance of plotly.graph_objs.layout.scene.camera.Up + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Up` - A dict of string/value properties that will be passed to the Up constructor @@ -7712,8 +7716,8 @@ def _prop_descriptions(self): This vector determines the view point about the origin of this scene. projection - plotly.graph_objects.layout.scene.camera.Projection - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.camera.Projec + tion` instance or dict with compatible properties up Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene @@ -7731,7 +7735,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.Camera + an instance of + :class:`plotly.graph_objs.layout.scene.Camera` center Sets the (x,y,z) components of the 'center' camera vector This vector determines the translation (x,y,z) @@ -7742,8 +7747,8 @@ def __init__( This vector determines the view point about the origin of this scene. projection - plotly.graph_objects.layout.scene.camera.Projection - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.camera.Projec + tion` instance or dict with compatible properties up Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene @@ -7769,7 +7774,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.Camera constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Camera""" +an instance of :class:`plotly.graph_objs.layout.scene.Camera`""" ) # Handle skip_invalid @@ -7897,7 +7902,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.Aspectratio + :class:`plotly.graph_objs.layout.scene.Aspectratio` x y @@ -7924,7 +7929,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.Aspectratio constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Aspectratio""" +an instance of :class:`plotly.graph_objs.layout.scene.Aspectratio`""" ) # Handle skip_invalid @@ -8370,7 +8375,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.annotation.Font + - An instance of :class:`plotly.graph_objs.layout.scene.annotation.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -8434,7 +8439,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.layout.scene.annotation.Hoverlabel + - An instance of :class:`plotly.graph_objs.layout.scene.annotation.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -9003,8 +9008,8 @@ def _prop_descriptions(self): (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.scene.annotation.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.annotation.Ho + verlabel` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. @@ -9161,7 +9166,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.Annotation + :class:`plotly.graph_objs.layout.scene.Annotation` align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more @@ -9212,8 +9217,8 @@ def __init__( (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.scene.annotation.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.annotation.Ho + verlabel` instance or dict with compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. @@ -9338,7 +9343,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.Annotation constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Annotation""" +an instance of :class:`plotly.graph_objs.layout.scene.Annotation`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/__init__.py index bedee123b62..a49895b77d7 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/__init__.py @@ -136,7 +136,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.annotation.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.layout.scene.annotation.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -205,8 +205,8 @@ def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.annotation.Hoverlabel + an instance of :class:`plotly.graph_objs.layout.scene.a + nnotation.Hoverlabel` bgcolor Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or @@ -239,7 +239,7 @@ def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs """\ The first argument to the plotly.graph_objs.layout.scene.annotation.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.annotation.Hoverlabel""" +an instance of :class:`plotly.graph_objs.layout.scene.annotation.Hoverlabel`""" ) # Handle skip_invalid @@ -428,7 +428,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.annotation.Font + :class:`plotly.graph_objs.layout.scene.annotation.Font` color family @@ -467,7 +467,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.annotation.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.annotation.Font""" +an instance of :class:`plotly.graph_objs.layout.scene.annotation.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py index 1a712f293bf..95d6f9532d7 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.annotatio - n.hoverlabel.Font + an instance of :class:`plotly.graph_objs.layout.scene.a + nnotation.hoverlabel.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.annotation.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.annotation.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.layout.scene.annotation.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/__init__.py index f6e8faa03c9..0c7ed39d465 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/__init__.py @@ -90,7 +90,8 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.camera.Up + an instance of + :class:`plotly.graph_objs.layout.scene.camera.Up` x y @@ -117,7 +118,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.camera.Up constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Up""" +an instance of :class:`plotly.graph_objs.layout.scene.camera.Up`""" ) # Handle skip_invalid @@ -205,8 +206,8 @@ def __init__(self, arg=None, type=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.camera.Projection + an instance of :class:`plotly.graph_objs.layout.scene.c + amera.Projection` type Sets the projection type. The projection type could be either "perspective" or "orthographic". The default is @@ -231,7 +232,7 @@ def __init__(self, arg=None, type=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.camera.Projection constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Projection""" +an instance of :class:`plotly.graph_objs.layout.scene.camera.Projection`""" ) # Handle skip_invalid @@ -352,7 +353,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.camera.Eye + :class:`plotly.graph_objs.layout.scene.camera.Eye` x y @@ -379,7 +380,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.camera.Eye constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Eye""" +an instance of :class:`plotly.graph_objs.layout.scene.camera.Eye`""" ) # Handle skip_invalid @@ -506,7 +507,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.camera.Center + :class:`plotly.graph_objs.layout.scene.camera.Center` x y @@ -533,7 +534,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.camera.Center constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Center""" +an instance of :class:`plotly.graph_objs.layout.scene.camera.Center`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/__init__.py index 1d2b943f0ca..11d7380a523 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.xaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -104,7 +104,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.xaxis.Title + :class:`plotly.graph_objs.layout.scene.xaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.xaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.xaxis.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.scene.x + axis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -608,7 +608,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.xaxis.Tickfont + :class:`plotly.graph_objs.layout.scene.xaxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/__init__.py index 8a669b33524..a77aaf50ce1 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.xaxis.title.Font + an instance of :class:`plotly.graph_objs.layout.scene.x + axis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.xaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/__init__.py index 34c252e3340..9d11fce4d88 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.yaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -104,7 +104,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.yaxis.Title + :class:`plotly.graph_objs.layout.scene.yaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.yaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.yaxis.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.scene.y + axis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -608,7 +608,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.yaxis.Tickfont + :class:`plotly.graph_objs.layout.scene.yaxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/__init__.py index 03bbb41d19d..44f8eab8e95 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.yaxis.title.Font + an instance of :class:`plotly.graph_objs.layout.scene.y + axis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.yaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/__init__.py index 452b68202c3..988aef9e4ec 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.scene.zaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -104,7 +104,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.zaxis.Title + :class:`plotly.graph_objs.layout.scene.zaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.zaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.zaxis.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.scene.z + axis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -608,7 +608,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.scene.zaxis.Tickfont + :class:`plotly.graph_objs.layout.scene.zaxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/__init__.py index 6abf5c7b495..87bddf5e9e1 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.zaxis.title.Font + an instance of :class:`plotly.graph_objs.layout.scene.z + axis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.scene.zaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/shape/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/shape/__init__.py index cb7b0393c0a..9506e7a649c 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/shape/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/shape/__init__.py @@ -139,7 +139,8 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.shape.Line + an instance of + :class:`plotly.graph_objs.layout.shape.Line` color Sets the line color. dash @@ -169,7 +170,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.shape.Line constructor must be a dict or -an instance of plotly.graph_objs.layout.shape.Line""" +an instance of :class:`plotly.graph_objs.layout.shape.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/slider/__init__.py index 4cc96f34d4d..995c93645ff 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/slider/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/slider/__init__.py @@ -79,7 +79,7 @@ def __init__(self, arg=None, duration=None, easing=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.slider.Transition + :class:`plotly.graph_objs.layout.slider.Transition` duration Sets the duration of the slider transition easing @@ -104,7 +104,7 @@ def __init__(self, arg=None, duration=None, easing=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.slider.Transition constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Transition""" +an instance of :class:`plotly.graph_objs.layout.slider.Transition`""" ) # Handle skip_invalid @@ -416,7 +416,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.slider.Step + an instance of + :class:`plotly.graph_objs.layout.slider.Step` args Sets the arguments values to be passed to the Plotly method set in `method` on slide. @@ -483,7 +484,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.slider.Step constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Step""" +an instance of :class:`plotly.graph_objs.layout.slider.Step`""" ) # Handle skip_invalid @@ -659,7 +660,8 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.slider.Pad + an instance of + :class:`plotly.graph_objs.layout.slider.Pad` b The amount of padding (in px) along the bottom of the component. @@ -692,7 +694,7 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.slider.Pad constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Pad""" +an instance of :class:`plotly.graph_objs.layout.slider.Pad`""" ) # Handle skip_invalid @@ -883,7 +885,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.slider.Font + an instance of + :class:`plotly.graph_objs.layout.slider.Font` color family @@ -922,7 +925,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.slider.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Font""" +an instance of :class:`plotly.graph_objs.layout.slider.Font`""" ) # Handle skip_invalid @@ -972,7 +975,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.slider.currentvalue.Font + - An instance of :class:`plotly.graph_objs.layout.slider.currentvalue.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1163,7 +1166,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.slider.Currentvalue + :class:`plotly.graph_objs.layout.slider.Currentvalue` font Sets the font of the current value label text. offset @@ -1200,7 +1203,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.slider.Currentvalue constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Currentvalue""" +an instance of :class:`plotly.graph_objs.layout.slider.Currentvalue`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/__init__.py index dd7b230006a..4ea75ade8b8 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/__init__.py @@ -151,8 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.slider.currentvalue.Font + an instance of :class:`plotly.graph_objs.layout.slider. + currentvalue.Font` color family @@ -191,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.slider.currentvalue.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.currentvalue.Font""" +an instance of :class:`plotly.graph_objs.layout.slider.currentvalue.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/template/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/template/__init__.py index 9f5b97e0e4c..d79d09c5515 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/template/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/template/__init__.py @@ -1099,146 +1099,148 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ area - A tuple of plotly.graph_objects.Area instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Area` instances + or dicts with compatible properties barpolar - A tuple of plotly.graph_objects.Barpolar instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Barpolar` + instances or dicts with compatible properties bar - A tuple of plotly.graph_objects.Bar instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Bar` instances + or dicts with compatible properties box - A tuple of plotly.graph_objects.Box instances or dicts - with compatible properties - candlestick - A tuple of plotly.graph_objects.Candlestick instances + A tuple of :class:`plotly.graph_objects.Box` instances or dicts with compatible properties + candlestick + A tuple of :class:`plotly.graph_objects.Candlestick` + instances or dicts with compatible properties carpet - A tuple of plotly.graph_objects.Carpet instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Carpet` + instances or dicts with compatible properties choroplethmapbox - A tuple of plotly.graph_objects.Choroplethmapbox + A tuple of + :class:`plotly.graph_objects.Choroplethmapbox` instances or dicts with compatible properties choropleth - A tuple of plotly.graph_objects.Choropleth instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Choropleth` + instances or dicts with compatible properties cone - A tuple of plotly.graph_objects.Cone instances or dicts - with compatible properties - contourcarpet - A tuple of plotly.graph_objects.Contourcarpet instances + A tuple of :class:`plotly.graph_objects.Cone` instances or dicts with compatible properties + contourcarpet + A tuple of :class:`plotly.graph_objects.Contourcarpet` + instances or dicts with compatible properties contour - A tuple of plotly.graph_objects.Contour instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Contour` + instances or dicts with compatible properties densitymapbox - A tuple of plotly.graph_objects.Densitymapbox instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Densitymapbox` + instances or dicts with compatible properties funnelarea - A tuple of plotly.graph_objects.Funnelarea instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Funnelarea` + instances or dicts with compatible properties funnel - A tuple of plotly.graph_objects.Funnel instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Funnel` + instances or dicts with compatible properties heatmapgl - A tuple of plotly.graph_objects.Heatmapgl instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Heatmapgl` + instances or dicts with compatible properties heatmap - A tuple of plotly.graph_objects.Heatmap instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Heatmap` + instances or dicts with compatible properties histogram2dcontour - A tuple of plotly.graph_objects.Histogram2dContour + A tuple of + :class:`plotly.graph_objects.Histogram2dContour` instances or dicts with compatible properties histogram2d - A tuple of plotly.graph_objects.Histogram2d instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Histogram2d` + instances or dicts with compatible properties histogram - A tuple of plotly.graph_objects.Histogram instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Histogram` + instances or dicts with compatible properties image - A tuple of plotly.graph_objects.Image instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Image` + instances or dicts with compatible properties indicator - A tuple of plotly.graph_objects.Indicator instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Indicator` + instances or dicts with compatible properties isosurface - A tuple of plotly.graph_objects.Isosurface instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Isosurface` + instances or dicts with compatible properties mesh3d - A tuple of plotly.graph_objects.Mesh3d instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Mesh3d` + instances or dicts with compatible properties ohlc - A tuple of plotly.graph_objects.Ohlc instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Ohlc` instances + or dicts with compatible properties parcats - A tuple of plotly.graph_objects.Parcats instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Parcats` + instances or dicts with compatible properties parcoords - A tuple of plotly.graph_objects.Parcoords instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Parcoords` + instances or dicts with compatible properties pie - A tuple of plotly.graph_objects.Pie instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Pie` instances + or dicts with compatible properties pointcloud - A tuple of plotly.graph_objects.Pointcloud instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Pointcloud` + instances or dicts with compatible properties sankey - A tuple of plotly.graph_objects.Sankey instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Sankey` + instances or dicts with compatible properties scatter3d - A tuple of plotly.graph_objects.Scatter3d instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scatter3d` + instances or dicts with compatible properties scattercarpet - A tuple of plotly.graph_objects.Scattercarpet instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattercarpet` + instances or dicts with compatible properties scattergeo - A tuple of plotly.graph_objects.Scattergeo instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattergeo` + instances or dicts with compatible properties scattergl - A tuple of plotly.graph_objects.Scattergl instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattergl` + instances or dicts with compatible properties scattermapbox - A tuple of plotly.graph_objects.Scattermapbox instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattermapbox` + instances or dicts with compatible properties scatterpolargl - A tuple of plotly.graph_objects.Scatterpolargl + A tuple of :class:`plotly.graph_objects.Scatterpolargl` instances or dicts with compatible properties scatterpolar - A tuple of plotly.graph_objects.Scatterpolar instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scatterpolar` + instances or dicts with compatible properties scatter - A tuple of plotly.graph_objects.Scatter instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scatter` + instances or dicts with compatible properties scatterternary - A tuple of plotly.graph_objects.Scatterternary + A tuple of :class:`plotly.graph_objects.Scatterternary` instances or dicts with compatible properties splom - A tuple of plotly.graph_objects.Splom instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Splom` + instances or dicts with compatible properties streamtube - A tuple of plotly.graph_objects.Streamtube instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Streamtube` + instances or dicts with compatible properties sunburst - A tuple of plotly.graph_objects.Sunburst instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Sunburst` + instances or dicts with compatible properties surface - A tuple of plotly.graph_objects.Surface instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Surface` + instances or dicts with compatible properties table - A tuple of plotly.graph_objects.Table instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Table` + instances or dicts with compatible properties treemap - A tuple of plotly.graph_objects.Treemap instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Treemap` + instances or dicts with compatible properties violin - A tuple of plotly.graph_objects.Violin instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Violin` + instances or dicts with compatible properties volume - A tuple of plotly.graph_objects.Volume instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Volume` + instances or dicts with compatible properties waterfall - A tuple of plotly.graph_objects.Waterfall instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Waterfall` + instances or dicts with compatible properties """ def __init__( @@ -1300,148 +1302,151 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.template.Data + an instance of + :class:`plotly.graph_objs.layout.template.Data` area - A tuple of plotly.graph_objects.Area instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Area` instances + or dicts with compatible properties barpolar - A tuple of plotly.graph_objects.Barpolar instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Barpolar` + instances or dicts with compatible properties bar - A tuple of plotly.graph_objects.Bar instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Bar` instances + or dicts with compatible properties box - A tuple of plotly.graph_objects.Box instances or dicts - with compatible properties - candlestick - A tuple of plotly.graph_objects.Candlestick instances + A tuple of :class:`plotly.graph_objects.Box` instances or dicts with compatible properties + candlestick + A tuple of :class:`plotly.graph_objects.Candlestick` + instances or dicts with compatible properties carpet - A tuple of plotly.graph_objects.Carpet instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Carpet` + instances or dicts with compatible properties choroplethmapbox - A tuple of plotly.graph_objects.Choroplethmapbox + A tuple of + :class:`plotly.graph_objects.Choroplethmapbox` instances or dicts with compatible properties choropleth - A tuple of plotly.graph_objects.Choropleth instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Choropleth` + instances or dicts with compatible properties cone - A tuple of plotly.graph_objects.Cone instances or dicts - with compatible properties - contourcarpet - A tuple of plotly.graph_objects.Contourcarpet instances + A tuple of :class:`plotly.graph_objects.Cone` instances or dicts with compatible properties + contourcarpet + A tuple of :class:`plotly.graph_objects.Contourcarpet` + instances or dicts with compatible properties contour - A tuple of plotly.graph_objects.Contour instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Contour` + instances or dicts with compatible properties densitymapbox - A tuple of plotly.graph_objects.Densitymapbox instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Densitymapbox` + instances or dicts with compatible properties funnelarea - A tuple of plotly.graph_objects.Funnelarea instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Funnelarea` + instances or dicts with compatible properties funnel - A tuple of plotly.graph_objects.Funnel instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Funnel` + instances or dicts with compatible properties heatmapgl - A tuple of plotly.graph_objects.Heatmapgl instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Heatmapgl` + instances or dicts with compatible properties heatmap - A tuple of plotly.graph_objects.Heatmap instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Heatmap` + instances or dicts with compatible properties histogram2dcontour - A tuple of plotly.graph_objects.Histogram2dContour + A tuple of + :class:`plotly.graph_objects.Histogram2dContour` instances or dicts with compatible properties histogram2d - A tuple of plotly.graph_objects.Histogram2d instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Histogram2d` + instances or dicts with compatible properties histogram - A tuple of plotly.graph_objects.Histogram instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Histogram` + instances or dicts with compatible properties image - A tuple of plotly.graph_objects.Image instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Image` + instances or dicts with compatible properties indicator - A tuple of plotly.graph_objects.Indicator instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Indicator` + instances or dicts with compatible properties isosurface - A tuple of plotly.graph_objects.Isosurface instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Isosurface` + instances or dicts with compatible properties mesh3d - A tuple of plotly.graph_objects.Mesh3d instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Mesh3d` + instances or dicts with compatible properties ohlc - A tuple of plotly.graph_objects.Ohlc instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Ohlc` instances + or dicts with compatible properties parcats - A tuple of plotly.graph_objects.Parcats instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Parcats` + instances or dicts with compatible properties parcoords - A tuple of plotly.graph_objects.Parcoords instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Parcoords` + instances or dicts with compatible properties pie - A tuple of plotly.graph_objects.Pie instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.Pie` instances + or dicts with compatible properties pointcloud - A tuple of plotly.graph_objects.Pointcloud instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Pointcloud` + instances or dicts with compatible properties sankey - A tuple of plotly.graph_objects.Sankey instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Sankey` + instances or dicts with compatible properties scatter3d - A tuple of plotly.graph_objects.Scatter3d instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scatter3d` + instances or dicts with compatible properties scattercarpet - A tuple of plotly.graph_objects.Scattercarpet instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattercarpet` + instances or dicts with compatible properties scattergeo - A tuple of plotly.graph_objects.Scattergeo instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattergeo` + instances or dicts with compatible properties scattergl - A tuple of plotly.graph_objects.Scattergl instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattergl` + instances or dicts with compatible properties scattermapbox - A tuple of plotly.graph_objects.Scattermapbox instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scattermapbox` + instances or dicts with compatible properties scatterpolargl - A tuple of plotly.graph_objects.Scatterpolargl + A tuple of :class:`plotly.graph_objects.Scatterpolargl` instances or dicts with compatible properties scatterpolar - A tuple of plotly.graph_objects.Scatterpolar instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scatterpolar` + instances or dicts with compatible properties scatter - A tuple of plotly.graph_objects.Scatter instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Scatter` + instances or dicts with compatible properties scatterternary - A tuple of plotly.graph_objects.Scatterternary + A tuple of :class:`plotly.graph_objects.Scatterternary` instances or dicts with compatible properties splom - A tuple of plotly.graph_objects.Splom instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Splom` + instances or dicts with compatible properties streamtube - A tuple of plotly.graph_objects.Streamtube instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Streamtube` + instances or dicts with compatible properties sunburst - A tuple of plotly.graph_objects.Sunburst instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Sunburst` + instances or dicts with compatible properties surface - A tuple of plotly.graph_objects.Surface instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Surface` + instances or dicts with compatible properties table - A tuple of plotly.graph_objects.Table instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Table` + instances or dicts with compatible properties treemap - A tuple of plotly.graph_objects.Treemap instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Treemap` + instances or dicts with compatible properties violin - A tuple of plotly.graph_objects.Violin instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Violin` + instances or dicts with compatible properties volume - A tuple of plotly.graph_objects.Volume instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Volume` + instances or dicts with compatible properties waterfall - A tuple of plotly.graph_objects.Waterfall instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Waterfall` + instances or dicts with compatible properties Returns ------- @@ -1462,7 +1467,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.template.Data constructor must be a dict or -an instance of plotly.graph_objs.layout.template.Data""" +an instance of :class:`plotly.graph_objs.layout.template.Data`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/__init__.py index 664042e6ab0..15e8cd6c477 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/__init__.py @@ -133,7 +133,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Domain + an instance of + :class:`plotly.graph_objs.layout.ternary.Domain` column If there is a layout grid, use the domain for this column in the grid for this ternary subplot . @@ -166,7 +167,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.Domain constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Domain""" +an instance of :class:`plotly.graph_objs.layout.ternary.Domain`""" ) # Handle skip_invalid @@ -863,7 +864,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.caxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -997,7 +998,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.caxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1235,7 +1236,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.caxis.Title + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1273,7 +1274,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.caxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1469,9 +1470,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary.caxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.ternary. + caxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.tern ary.caxis.tickformatstopdefaults), sets the default @@ -1511,8 +1512,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.caxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.caxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.ternary.caxis.title.font instead. Sets this axis' title font. Note that the @@ -1576,7 +1577,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Caxis + an instance of + :class:`plotly.graph_objs.layout.ternary.Caxis` color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid @@ -1705,9 +1707,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary.caxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.ternary. + caxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.tern ary.caxis.tickformatstopdefaults), sets the default @@ -1747,8 +1749,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.caxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.caxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.ternary.caxis.title.font instead. Sets this axis' title font. Note that the @@ -1778,7 +1780,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.ternary.Caxis constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Caxis""" +an instance of :class:`plotly.graph_objs.layout.ternary.Caxis`""" ) # Handle skip_invalid @@ -2582,7 +2584,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.baxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2716,7 +2718,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.baxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2954,7 +2956,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.baxis.Title + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2992,7 +2994,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.baxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -3188,9 +3190,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary.baxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.ternary. + baxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.tern ary.baxis.tickformatstopdefaults), sets the default @@ -3230,8 +3232,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.baxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.baxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.ternary.baxis.title.font instead. Sets this axis' title font. Note that the @@ -3295,7 +3297,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Baxis + an instance of + :class:`plotly.graph_objs.layout.ternary.Baxis` color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid @@ -3424,9 +3427,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary.baxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.ternary. + baxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.tern ary.baxis.tickformatstopdefaults), sets the default @@ -3466,8 +3469,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.baxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.baxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.ternary.baxis.title.font instead. Sets this axis' title font. Note that the @@ -3497,7 +3500,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.ternary.Baxis constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Baxis""" +an instance of :class:`plotly.graph_objs.layout.ternary.Baxis`""" ) # Handle skip_invalid @@ -4301,7 +4304,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.aaxis.Tickfont + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -4435,7 +4438,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -4673,7 +4676,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.aaxis.Title + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -4711,7 +4714,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.aaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -4907,9 +4910,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary.aaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.ternary. + aaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.tern ary.aaxis.tickformatstopdefaults), sets the default @@ -4949,8 +4952,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.aaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.aaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.ternary.aaxis.title.font instead. Sets this axis' title font. Note that the @@ -5014,7 +5017,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Aaxis + an instance of + :class:`plotly.graph_objs.layout.ternary.Aaxis` color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid @@ -5143,9 +5147,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary.aaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout.ternary. + aaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.layout.tern ary.aaxis.tickformatstopdefaults), sets the default @@ -5185,8 +5189,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.aaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.aaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.ternary.aaxis.title.font instead. Sets this axis' title font. Note that the @@ -5216,7 +5220,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.ternary.Aaxis constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Aaxis""" +an instance of :class:`plotly.graph_objs.layout.ternary.Aaxis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/__init__.py index 620658e2785..e44fe21a26a 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.aaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -104,7 +104,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.ternary.aaxis.Title + :class:`plotly.graph_objs.layout.ternary.aaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.aaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.ternary + .aaxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -607,8 +607,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.Tickfont + an instance of :class:`plotly.graph_objs.layout.ternary + .aaxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py index 48d394b4f4c..9c84bf70740 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.title.Font + an instance of :class:`plotly.graph_objs.layout.ternary + .aaxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.aaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/__init__.py index 8a98c1946d1..93ed0e9a2b5 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.baxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -104,7 +104,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.ternary.baxis.Title + :class:`plotly.graph_objs.layout.ternary.baxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.baxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.Title""" +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.ternary + .baxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickformatstop`""" ) # Handle skip_invalid @@ -607,8 +607,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.Tickfont + an instance of :class:`plotly.graph_objs.layout.ternary + .baxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/__init__.py index 2c4c69d08b7..1aefc3eb182 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.title.Font + an instance of :class:`plotly.graph_objs.layout.ternary + .baxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.baxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/__init__.py index 365d1cee14b..0340f22b7c6 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.ternary.caxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -104,7 +104,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.ternary.caxis.Title + :class:`plotly.graph_objs.layout.ternary.caxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -134,7 +134,7 @@ def __init__(self, arg=None, font=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.caxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.Title""" +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.Title`""" ) # Handle skip_invalid @@ -355,8 +355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.Tickformatstop + an instance of :class:`plotly.graph_objs.layout.ternary + .caxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -407,7 +407,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickformatstop`""" ) # Handle skip_invalid @@ -607,8 +607,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.Tickfont + an instance of :class:`plotly.graph_objs.layout.ternary + .caxis.Tickfont` color family @@ -647,7 +647,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/__init__.py index b85939c3d14..86c3c875c74 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.title.Font + an instance of :class:`plotly.graph_objs.layout.ternary + .caxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.ternary.caxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/title/__init__.py index 668d3e1b3c1..76f6765d317 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/title/__init__.py @@ -127,7 +127,8 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.title.Pad + an instance of + :class:`plotly.graph_objs.layout.title.Pad` b The amount of padding (in px) along the bottom of the component. @@ -160,7 +161,7 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.title.Pad constructor must be a dict or -an instance of plotly.graph_objs.layout.title.Pad""" +an instance of :class:`plotly.graph_objs.layout.title.Pad`""" ) # Handle skip_invalid @@ -352,7 +353,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.title.Font + an instance of + :class:`plotly.graph_objs.layout.title.Font` color family @@ -391,7 +393,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.title.Font""" +an instance of :class:`plotly.graph_objs.layout.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/__init__.py index 8189202f915..a3ca3c06cf3 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/__init__.py @@ -122,7 +122,8 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.updatemenu.Pad + an instance of + :class:`plotly.graph_objs.layout.updatemenu.Pad` b The amount of padding (in px) along the bottom of the component. @@ -155,7 +156,7 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.updatemenu.Pad constructor must be a dict or -an instance of plotly.graph_objs.layout.updatemenu.Pad""" +an instance of :class:`plotly.graph_objs.layout.updatemenu.Pad`""" ) # Handle skip_invalid @@ -346,7 +347,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.updatemenu.Font + an instance of + :class:`plotly.graph_objs.layout.updatemenu.Font` color family @@ -385,7 +387,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.updatemenu.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.updatemenu.Font""" +an instance of :class:`plotly.graph_objs.layout.updatemenu.Font`""" ) # Handle skip_invalid @@ -705,7 +707,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.updatemenu.Button + :class:`plotly.graph_objs.layout.updatemenu.Button` args Sets the arguments values to be passed to the Plotly method set in `method` on click. @@ -773,7 +775,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.updatemenu.Button constructor must be a dict or -an instance of plotly.graph_objs.layout.updatemenu.Button""" +an instance of :class:`plotly.graph_objs.layout.updatemenu.Button`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/__init__.py index b8c5a57e220..e6d0c2f9de8 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.xaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -140,7 +140,8 @@ def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.xaxis.Title + an instance of + :class:`plotly.graph_objs.layout.xaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -180,7 +181,7 @@ def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.xaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.xaxis.Title`""" ) # Handle skip_invalid @@ -405,7 +406,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.xaxis.Tickformatstop + :class:`plotly.graph_objs.layout.xaxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -456,7 +457,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.xaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.xaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -654,7 +655,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.xaxis.Tickfont + an instance of + :class:`plotly.graph_objs.layout.xaxis.Tickfont` color family @@ -693,7 +695,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.xaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.xaxis.Tickfont`""" ) # Handle skip_invalid @@ -974,7 +976,7 @@ def yaxis(self): """ The 'yaxis' property is an instance of YAxis that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.rangeslider.YAxis + - An instance of :class:`plotly.graph_objs.layout.xaxis.rangeslider.YAxis` - A dict of string/value properties that will be passed to the YAxis constructor @@ -1041,8 +1043,8 @@ def _prop_descriptions(self): visible. If visible, perpendicular axes will be set to `fixedrange` yaxis - plotly.graph_objects.layout.xaxis.rangeslider.YAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.rangeslider.Y + Axis` instance or dict with compatible properties """ def __init__( @@ -1066,7 +1068,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.xaxis.Rangeslider + :class:`plotly.graph_objs.layout.xaxis.Rangeslider` autorange Determines whether or not the range slider range is computed in relation to the input data. If `range` is @@ -1095,8 +1097,8 @@ def __init__( visible. If visible, perpendicular axes will be set to `fixedrange` yaxis - plotly.graph_objects.layout.xaxis.rangeslider.YAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.rangeslider.Y + Axis` instance or dict with compatible properties Returns ------- @@ -1117,7 +1119,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.xaxis.Rangeslider constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Rangeslider""" +an instance of :class:`plotly.graph_objs.layout.xaxis.Rangeslider`""" ) # Handle skip_invalid @@ -1455,7 +1457,7 @@ def buttondefaults(self): The 'buttondefaults' property is an instance of Button that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.rangeselector.Button + - An instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Button` - A dict of string/value properties that will be passed to the Button constructor @@ -1480,7 +1482,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.xaxis.rangeselector.Font + - An instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1704,7 +1706,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.xaxis.Rangeselector + :class:`plotly.graph_objs.layout.xaxis.Rangeselector` activecolor Sets the background color of the active range selector button. @@ -1765,7 +1767,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.xaxis.Rangeselector constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Rangeselector""" +an instance of :class:`plotly.graph_objs.layout.xaxis.Rangeselector`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py index 123377aafc4..a68a7411a05 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py @@ -151,8 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.rangeselector.Font + an instance of :class:`plotly.graph_objs.layout.xaxis.r + angeselector.Font` color family @@ -191,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.rangeselector.Font""" +an instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Font`""" ) # Handle skip_invalid @@ -476,8 +476,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.rangeselector.Button + an instance of :class:`plotly.graph_objs.layout.xaxis.r + angeselector.Button` count Sets the number of steps to take to update the range. Use with `step` to specify the update interval. @@ -538,7 +538,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Button constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.rangeselector.Button""" +an instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Button`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py index 9a5c5bdea03..8529a311c22 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py @@ -82,8 +82,8 @@ def __init__(self, arg=None, range=None, rangemode=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.rangeslider.YAxis + an instance of :class:`plotly.graph_objs.layout.xaxis.r + angeslider.YAxis` range Sets the range of this axis for the rangeslider. rangemode @@ -113,7 +113,7 @@ def __init__(self, arg=None, range=None, rangemode=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.xaxis.rangeslider.YAxis constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.rangeslider.YAxis""" +an instance of :class:`plotly.graph_objs.layout.xaxis.rangeslider.YAxis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/__init__.py index c2a86c3ea03..c9083b29ed1 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.xaxis.title.Font + :class:`plotly.graph_objs.layout.xaxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.xaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.xaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/__init__.py index 37359fb7536..5fb74027fc7 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.layout.yaxis.title.Font + - An instance of :class:`plotly.graph_objs.layout.yaxis.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -140,7 +140,8 @@ def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.yaxis.Title + an instance of + :class:`plotly.graph_objs.layout.yaxis.Title` font Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` @@ -180,7 +181,7 @@ def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.yaxis.Title constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.Title""" +an instance of :class:`plotly.graph_objs.layout.yaxis.Title`""" ) # Handle skip_invalid @@ -405,7 +406,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.yaxis.Tickformatstop + :class:`plotly.graph_objs.layout.yaxis.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -456,7 +457,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.layout.yaxis.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.Tickformatstop""" +an instance of :class:`plotly.graph_objs.layout.yaxis.Tickformatstop`""" ) # Handle skip_invalid @@ -654,7 +655,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.yaxis.Tickfont + an instance of + :class:`plotly.graph_objs.layout.yaxis.Tickfont` color family @@ -693,7 +695,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.yaxis.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.Tickfont""" +an instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/__init__.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/__init__.py index 4d0c64d0ff8..aeaf3b9b525 100644 --- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.layout.yaxis.title.Font + :class:`plotly.graph_objs.layout.yaxis.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.layout.yaxis.title.Font constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.title.Font""" +an instance of :class:`plotly.graph_objs.layout.yaxis.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/__init__.py b/packages/python/plotly/plotly/graph_objs/mesh3d/__init__.py index 708930b8ab9..3a47ca28f2d 100644 --- a/packages/python/plotly/plotly/graph_objs/mesh3d/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/mesh3d/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Stream + an instance of :class:`plotly.graph_objs.mesh3d.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.mesh3d.Stream constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Stream""" +an instance of :class:`plotly.graph_objs.mesh3d.Stream`""" ) # Handle skip_invalid @@ -235,7 +235,8 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Lightposition + an instance of + :class:`plotly.graph_objs.mesh3d.Lightposition` x Numeric vector, representing the X coordinate for each vertex. @@ -265,7 +266,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.mesh3d.Lightposition constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Lightposition""" +an instance of :class:`plotly.graph_objs.mesh3d.Lightposition`""" ) # Handle skip_invalid @@ -509,7 +510,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Lighting + an instance of + :class:`plotly.graph_objs.mesh3d.Lighting` ambient Ambient light increases overall color visibility but can wash out the image. @@ -553,7 +555,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.mesh3d.Lighting constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Lighting""" +an instance of :class:`plotly.graph_objs.mesh3d.Lighting`""" ) # Handle skip_invalid @@ -827,7 +829,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.mesh3d.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.mesh3d.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -982,7 +984,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Hoverlabel + an instance of + :class:`plotly.graph_objs.mesh3d.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1031,7 +1034,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.mesh3d.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Hoverlabel""" +an instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel`""" ) # Handle skip_invalid @@ -1216,7 +1219,8 @@ def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Contour + an instance of + :class:`plotly.graph_objs.mesh3d.Contour` color Sets the color of the contour lines. show @@ -1243,7 +1247,7 @@ def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.mesh3d.Contour constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Contour""" +an instance of :class:`plotly.graph_objs.mesh3d.Contour`""" ) # Handle skip_invalid @@ -1905,7 +1909,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.mesh3d.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2039,7 +2043,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.mesh3d.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2277,7 +2281,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.mesh3d.colorbar.Title + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2320,7 +2324,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.mesh3d.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2629,9 +2633,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.mesh3d.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.mesh3d.colorbar + .Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.mesh3d .colorbar.tickformatstopdefaults), sets the default @@ -2671,8 +2675,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.mesh3d.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use mesh3d.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2766,7 +2770,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.ColorBar + an instance of + :class:`plotly.graph_objs.mesh3d.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2879,9 +2884,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.mesh3d.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.mesh3d.colorbar + .Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.mesh3d .colorbar.tickformatstopdefaults), sets the default @@ -2921,8 +2926,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.mesh3d.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use mesh3d.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2974,7 +2979,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.mesh3d.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.ColorBar""" +an instance of :class:`plotly.graph_objs.mesh3d.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/__init__.py index 86130792810..7d5bd97717e 100644 --- a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.mesh3d.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,7 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.colorbar.Title + an instance of + :class:`plotly.graph_objs.mesh3d.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -166,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.mesh3d.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.Title""" +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.Title`""" ) # Handle skip_invalid @@ -390,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.mesh3d.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.mesh3d.colorba + r.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -442,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -641,7 +642,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.mesh3d.colorbar.Tickfont + :class:`plotly.graph_objs.mesh3d.colorbar.Tickfont` color family @@ -680,7 +681,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/__init__.py index c73a1281d5d..8df6a3ea9c6 100644 --- a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.mesh3d.colorbar.title.Font + :class:`plotly.graph_objs.mesh3d.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.mesh3d.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/__init__.py index 7b1d38f1cd8..3f85c85ccd6 100644 --- a/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.mesh3d.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.mesh3d.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.mesh3d.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/__init__.py b/packages/python/plotly/plotly/graph_objs/ohlc/__init__.py index 6045b7202af..ca65d34b342 100644 --- a/packages/python/plotly/plotly/graph_objs/ohlc/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/ohlc/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Stream + an instance of :class:`plotly.graph_objs.ohlc.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.ohlc.Stream constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Stream""" +an instance of :class:`plotly.graph_objs.ohlc.Stream`""" ) # Handle skip_invalid @@ -227,7 +227,7 @@ def __init__(self, arg=None, dash=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Line + an instance of :class:`plotly.graph_objs.ohlc.Line` dash Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or @@ -259,7 +259,7 @@ def __init__(self, arg=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.ohlc.Line constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Line""" +an instance of :class:`plotly.graph_objs.ohlc.Line`""" ) # Handle skip_invalid @@ -304,7 +304,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.ohlc.increasing.Line + - An instance of :class:`plotly.graph_objs.ohlc.increasing.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -342,8 +342,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ line - plotly.graph_objects.ohlc.increasing.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.ohlc.increasing.Line` + instance or dict with compatible properties """ def __init__(self, arg=None, line=None, **kwargs): @@ -354,10 +354,11 @@ def __init__(self, arg=None, line=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Increasing + an instance of + :class:`plotly.graph_objs.ohlc.Increasing` line - plotly.graph_objects.ohlc.increasing.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.ohlc.increasing.Line` + instance or dict with compatible properties Returns ------- @@ -378,7 +379,7 @@ def __init__(self, arg=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.ohlc.Increasing constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Increasing""" +an instance of :class:`plotly.graph_objs.ohlc.Increasing`""" ) # Handle skip_invalid @@ -626,7 +627,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.ohlc.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.ohlc.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -806,7 +807,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Hoverlabel + an instance of + :class:`plotly.graph_objs.ohlc.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -858,7 +860,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.ohlc.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Hoverlabel""" +an instance of :class:`plotly.graph_objs.ohlc.Hoverlabel`""" ) # Handle skip_invalid @@ -927,7 +929,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.ohlc.decreasing.Line + - An instance of :class:`plotly.graph_objs.ohlc.decreasing.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -965,8 +967,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ line - plotly.graph_objects.ohlc.decreasing.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.ohlc.decreasing.Line` + instance or dict with compatible properties """ def __init__(self, arg=None, line=None, **kwargs): @@ -977,10 +979,11 @@ def __init__(self, arg=None, line=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Decreasing + an instance of + :class:`plotly.graph_objs.ohlc.Decreasing` line - plotly.graph_objects.ohlc.decreasing.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.ohlc.decreasing.Line` + instance or dict with compatible properties Returns ------- @@ -1001,7 +1004,7 @@ def __init__(self, arg=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.ohlc.Decreasing constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Decreasing""" +an instance of :class:`plotly.graph_objs.ohlc.Decreasing`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/__init__.py b/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/__init__.py index f4fdb6bf518..7cb9de8d09b 100644 --- a/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/__init__.py @@ -139,7 +139,8 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.decreasing.Line + an instance of + :class:`plotly.graph_objs.ohlc.decreasing.Line` color Sets the line color. dash @@ -169,7 +170,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.ohlc.decreasing.Line constructor must be a dict or -an instance of plotly.graph_objs.ohlc.decreasing.Line""" +an instance of :class:`plotly.graph_objs.ohlc.decreasing.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/__init__.py index 8d5ec3a3318..e23d71f2b1a 100644 --- a/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.ohlc.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.ohlc.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.ohlc.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.ohlc.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/increasing/__init__.py b/packages/python/plotly/plotly/graph_objs/ohlc/increasing/__init__.py index 6b70ca6da6e..7c6f96aba4a 100644 --- a/packages/python/plotly/plotly/graph_objs/ohlc/increasing/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/ohlc/increasing/__init__.py @@ -139,7 +139,8 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.increasing.Line + an instance of + :class:`plotly.graph_objs.ohlc.increasing.Line` color Sets the line color. dash @@ -169,7 +170,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.ohlc.increasing.Line constructor must be a dict or -an instance of plotly.graph_objs.ohlc.increasing.Line""" +an instance of :class:`plotly.graph_objs.ohlc.increasing.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcats/__init__.py b/packages/python/plotly/plotly/graph_objs/parcats/__init__.py index a5e3cb9ab9b..12e32706009 100644 --- a/packages/python/plotly/plotly/graph_objs/parcats/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcats/__init__.py @@ -151,7 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Tickfont + an instance of + :class:`plotly.graph_objs.parcats.Tickfont` color family @@ -190,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.parcats.Tickfont""" +an instance of :class:`plotly.graph_objs.parcats.Tickfont`""" ) # Handle skip_invalid @@ -304,7 +305,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Stream + an instance of + :class:`plotly.graph_objs.parcats.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -334,7 +336,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.Stream constructor must be a dict or -an instance of plotly.graph_objs.parcats.Stream""" +an instance of :class:`plotly.graph_objs.parcats.Stream`""" ) # Handle skip_invalid @@ -591,7 +593,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.parcats.line.ColorBar + - An instance of :class:`plotly.graph_objs.parcats.line.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -723,9 +725,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcats.line.co - lorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.parcats + .line.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.parcats.line.colorbar.tickformatstopdefaults) @@ -772,8 +774,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcats.line.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.parcats.line.color + bar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use parcats.line.colorbar.title.font instead. Sets @@ -1058,8 +1061,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcats.line.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.parcats.line.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale @@ -1142,7 +1145,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Line + an instance of :class:`plotly.graph_objs.parcats.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1190,8 +1193,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcats.line.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.parcats.line.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale @@ -1266,7 +1269,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcats.Line constructor must be a dict or -an instance of plotly.graph_objs.parcats.Line""" +an instance of :class:`plotly.graph_objs.parcats.Line`""" ) # Handle skip_invalid @@ -1487,7 +1490,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Labelfont + an instance of + :class:`plotly.graph_objs.parcats.Labelfont` color family @@ -1526,7 +1530,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.Labelfont constructor must be a dict or -an instance of plotly.graph_objs.parcats.Labelfont""" +an instance of :class:`plotly.graph_objs.parcats.Labelfont`""" ) # Handle skip_invalid @@ -1696,7 +1700,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Domain + an instance of + :class:`plotly.graph_objs.parcats.Domain` column If there is a layout grid, use the domain for this column in the grid for this parcats trace . @@ -1729,7 +1734,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.Domain constructor must be a dict or -an instance of plotly.graph_objs.parcats.Domain""" +an instance of :class:`plotly.graph_objs.parcats.Domain`""" ) # Handle skip_invalid @@ -2075,7 +2080,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Dimension + an instance of + :class:`plotly.graph_objs.parcats.Dimension` categoryarray Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to @@ -2138,7 +2144,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcats.Dimension constructor must be a dict or -an instance of plotly.graph_objs.parcats.Dimension""" +an instance of :class:`plotly.graph_objs.parcats.Dimension`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/__init__.py b/packages/python/plotly/plotly/graph_objs/parcats/line/__init__.py index 9cec530e890..71fca1d1d77 100644 --- a/packages/python/plotly/plotly/graph_objs/parcats/line/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcats/line/__init__.py @@ -625,7 +625,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.parcats.line.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -759,7 +759,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.parcats.line.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -997,7 +997,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.parcats.line.colorbar.Title + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1041,7 +1041,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.parcats.line.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1350,9 +1350,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcats.line.colorbar.T - ickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.parcats.line.co + lorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.parcat s.line.colorbar.tickformatstopdefaults), sets the @@ -1392,8 +1392,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcats.line.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.parcats.line.colorbar.Titl + e` instance or dict with compatible properties titlefont Deprecated: Please use parcats.line.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -1487,7 +1487,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.line.ColorBar + an instance of + :class:`plotly.graph_objs.parcats.line.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -1600,9 +1601,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcats.line.colorbar.T - ickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.parcats.line.co + lorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.parcat s.line.colorbar.tickformatstopdefaults), sets the @@ -1642,8 +1643,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcats.line.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.parcats.line.colorbar.Titl + e` instance or dict with compatible properties titlefont Deprecated: Please use parcats.line.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -1695,7 +1696,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcats.line.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.ColorBar""" +an instance of :class:`plotly.graph_objs.parcats.line.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/__init__.py index 11f0db3207f..6fac176f64e 100644 --- a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.parcats.line.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.parcats.line.colorbar.Title + :class:`plotly.graph_objs.parcats.line.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.line.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.Title""" +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.parcats.line.c + olorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.parcats.line.c + olorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/__init__.py index 0c3a2c7aec8..1866ad1eb5c 100644 --- a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.title.Font + an instance of :class:`plotly.graph_objs.parcats.line.c + olorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcats.line.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/__init__.py b/packages/python/plotly/plotly/graph_objs/parcoords/__init__.py index ab37e23b8e6..0eff9b16605 100644 --- a/packages/python/plotly/plotly/graph_objs/parcoords/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcoords/__init__.py @@ -151,7 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Tickfont + an instance of + :class:`plotly.graph_objs.parcoords.Tickfont` color family @@ -190,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Tickfont""" +an instance of :class:`plotly.graph_objs.parcoords.Tickfont`""" ) # Handle skip_invalid @@ -304,7 +305,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Stream + an instance of + :class:`plotly.graph_objs.parcoords.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -334,7 +336,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.Stream constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Stream""" +an instance of :class:`plotly.graph_objs.parcoords.Stream`""" ) # Handle skip_invalid @@ -519,7 +521,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Rangefont + an instance of + :class:`plotly.graph_objs.parcoords.Rangefont` color family @@ -558,7 +561,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.Rangefont constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Rangefont""" +an instance of :class:`plotly.graph_objs.parcoords.Rangefont`""" ) # Handle skip_invalid @@ -818,7 +821,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.parcoords.line.ColorBar + - An instance of :class:`plotly.graph_objs.parcoords.line.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -950,9 +953,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcoords.line. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.parcoor + ds.line.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.parcoords.line.colorbar.tickformatstopdefault @@ -999,8 +1002,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcoords.line.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use parcoords.line.colorbar.title.font instead. @@ -1222,8 +1226,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcoords.line.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale @@ -1276,7 +1280,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Line + an instance of + :class:`plotly.graph_objs.parcoords.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1324,8 +1329,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcoords.line.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale @@ -1372,7 +1377,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcoords.Line constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Line""" +an instance of :class:`plotly.graph_objs.parcoords.Line`""" ) # Handle skip_invalid @@ -1587,7 +1592,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Labelfont + an instance of + :class:`plotly.graph_objs.parcoords.Labelfont` color family @@ -1626,7 +1632,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.Labelfont constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Labelfont""" +an instance of :class:`plotly.graph_objs.parcoords.Labelfont`""" ) # Handle skip_invalid @@ -1796,7 +1802,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Domain + an instance of + :class:`plotly.graph_objs.parcoords.Domain` column If there is a layout grid, use the domain for this column in the grid for this parcoords trace . @@ -1829,7 +1836,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.Domain constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Domain""" +an instance of :class:`plotly.graph_objs.parcoords.Domain`""" ) # Handle skip_invalid @@ -2314,7 +2321,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Dimension + an instance of + :class:`plotly.graph_objs.parcoords.Dimension` constraintrange The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, @@ -2403,7 +2411,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcoords.Dimension constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Dimension""" +an instance of :class:`plotly.graph_objs.parcoords.Dimension`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/__init__.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/__init__.py index 649f6ba8267..c5dba2e2801 100644 --- a/packages/python/plotly/plotly/graph_objs/parcoords/line/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/__init__.py @@ -625,7 +625,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.parcoords.line.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -759,7 +759,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.parcoords.line.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -997,7 +997,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.parcoords.line.colorbar.Title + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1041,7 +1041,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.parcoords.line.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1350,9 +1350,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcoords.line.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.parcoords.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.parcoo rds.line.colorbar.tickformatstopdefaults), sets the @@ -1392,8 +1392,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcoords.line.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use parcoords.line.colorbar.title.font instead. Sets this @@ -1488,7 +1488,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.parcoords.line.ColorBar + :class:`plotly.graph_objs.parcoords.line.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -1601,9 +1601,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcoords.line.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.parcoords.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.parcoo rds.line.colorbar.tickformatstopdefaults), sets the @@ -1643,8 +1643,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcoords.line.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use parcoords.line.colorbar.title.font instead. Sets this @@ -1696,7 +1696,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcoords.line.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.ColorBar""" +an instance of :class:`plotly.graph_objs.parcoords.line.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/__init__.py index ed83968fdd0..f8b2caddad5 100644 --- a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.parcoords.line.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.colorbar.Title + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.line.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.Title""" +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.line.colorba - r.Tickformatstop + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py index 3bbbffec592..5391aa1d7bd 100644 --- a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.colorbar.title.Font + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.parcoords.line.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pie/__init__.py b/packages/python/plotly/plotly/graph_objs/pie/__init__.py index 5ab5125c463..4e95ace5603 100644 --- a/packages/python/plotly/plotly/graph_objs/pie/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pie/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.pie.title.Font + - An instance of :class:`plotly.graph_objs.pie.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -143,7 +143,7 @@ def __init__(self, arg=None, font=None, position=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Title + an instance of :class:`plotly.graph_objs.pie.Title` font Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` @@ -178,7 +178,7 @@ def __init__(self, arg=None, font=None, position=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.pie.Title constructor must be a dict or -an instance of plotly.graph_objs.pie.Title""" +an instance of :class:`plotly.graph_objs.pie.Title`""" ) # Handle skip_invalid @@ -445,7 +445,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Textfont + an instance of :class:`plotly.graph_objs.pie.Textfont` color colorsrc @@ -490,7 +490,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.Textfont constructor must be a dict or -an instance of plotly.graph_objs.pie.Textfont""" +an instance of :class:`plotly.graph_objs.pie.Textfont`""" ) # Handle skip_invalid @@ -613,7 +613,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Stream + an instance of :class:`plotly.graph_objs.pie.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -643,7 +643,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.pie.Stream constructor must be a dict or -an instance of plotly.graph_objs.pie.Stream""" +an instance of :class:`plotly.graph_objs.pie.Stream`""" ) # Handle skip_invalid @@ -907,7 +907,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Outsidetextfont + an instance of + :class:`plotly.graph_objs.pie.Outsidetextfont` color colorsrc @@ -952,7 +953,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.Outsidetextfont constructor must be a dict or -an instance of plotly.graph_objs.pie.Outsidetextfont""" +an instance of :class:`plotly.graph_objs.pie.Outsidetextfont`""" ) # Handle skip_invalid @@ -1050,7 +1051,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.pie.marker.Line + - An instance of :class:`plotly.graph_objs.pie.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1097,8 +1098,8 @@ def _prop_descriptions(self): colorssrc Sets the source reference on plot.ly for colors . line - plotly.graph_objects.pie.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.marker.Line` instance + or dict with compatible properties """ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): @@ -1109,7 +1110,7 @@ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Marker + an instance of :class:`plotly.graph_objs.pie.Marker` colors Sets the color of each sector. If not specified, the default trace color set is used to pick the sector @@ -1117,8 +1118,8 @@ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): colorssrc Sets the source reference on plot.ly for colors . line - plotly.graph_objects.pie.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.marker.Line` instance + or dict with compatible properties Returns ------- @@ -1139,7 +1140,7 @@ def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.pie.Marker constructor must be a dict or -an instance of plotly.graph_objs.pie.Marker""" +an instance of :class:`plotly.graph_objs.pie.Marker`""" ) # Handle skip_invalid @@ -1406,7 +1407,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Insidetextfont + an instance of + :class:`plotly.graph_objs.pie.Insidetextfont` color colorsrc @@ -1451,7 +1453,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.pie.Insidetextfont""" +an instance of :class:`plotly.graph_objs.pie.Insidetextfont`""" ) # Handle skip_invalid @@ -1714,7 +1716,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.pie.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.pie.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1869,7 +1871,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Hoverlabel + an instance of + :class:`plotly.graph_objs.pie.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1918,7 +1921,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.pie.Hoverlabel""" +an instance of :class:`plotly.graph_objs.pie.Hoverlabel`""" ) # Handle skip_invalid @@ -2105,7 +2108,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Domain + an instance of :class:`plotly.graph_objs.pie.Domain` column If there is a layout grid, use the domain for this column in the grid for this pie trace . @@ -2138,7 +2141,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.pie.Domain constructor must be a dict or -an instance of plotly.graph_objs.pie.Domain""" +an instance of :class:`plotly.graph_objs.pie.Domain`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/__init__.py index 4eaab91fe19..1dbc0936d61 100644 --- a/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.pie.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.pie.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.pie.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pie/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/pie/marker/__init__.py index 169579ff181..d48cb655445 100644 --- a/packages/python/plotly/plotly/graph_objs/pie/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pie/marker/__init__.py @@ -157,7 +157,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.marker.Line + an instance of + :class:`plotly.graph_objs.pie.marker.Line` color Sets the color of the line enclosing each sector. colorsrc @@ -187,7 +188,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.pie.marker.Line""" +an instance of :class:`plotly.graph_objs.pie.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pie/title/__init__.py b/packages/python/plotly/plotly/graph_objs/pie/title/__init__.py index 14865484abf..47d7503e162 100644 --- a/packages/python/plotly/plotly/graph_objs/pie/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pie/title/__init__.py @@ -231,7 +231,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.title.Font + an instance of + :class:`plotly.graph_objs.pie.title.Font` color colorsrc @@ -276,7 +277,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pie.title.Font constructor must be a dict or -an instance of plotly.graph_objs.pie.title.Font""" +an instance of :class:`plotly.graph_objs.pie.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/__init__.py b/packages/python/plotly/plotly/graph_objs/pointcloud/__init__.py index bcd2cd197fb..0efb5d8fc77 100644 --- a/packages/python/plotly/plotly/graph_objs/pointcloud/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pointcloud/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pointcloud.Stream + an instance of + :class:`plotly.graph_objs.pointcloud.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.pointcloud.Stream constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.Stream""" +an instance of :class:`plotly.graph_objs.pointcloud.Stream`""" ) # Handle skip_invalid @@ -175,7 +176,7 @@ def border(self): """ The 'border' property is an instance of Border that may be specified as: - - An instance of plotly.graph_objs.pointcloud.marker.Border + - An instance of :class:`plotly.graph_objs.pointcloud.marker.Border` - A dict of string/value properties that will be passed to the Border constructor @@ -344,8 +345,8 @@ def _prop_descriptions(self): value less then `1`. Setting `blend` to `true` reduces zoom/pan speed if used with large numbers of points. border - plotly.graph_objects.pointcloud.marker.Border instance - or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.marker.Border` + instance or dict with compatible properties color Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are @@ -386,15 +387,16 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pointcloud.Marker + an instance of + :class:`plotly.graph_objs.pointcloud.Marker` blend Determines if colors are blended together for a translucency effect in case `opacity` is specified as a value less then `1`. Setting `blend` to `true` reduces zoom/pan speed if used with large numbers of points. border - plotly.graph_objects.pointcloud.marker.Border instance - or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.marker.Border` + instance or dict with compatible properties color Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are @@ -435,7 +437,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pointcloud.Marker constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.Marker""" +an instance of :class:`plotly.graph_objs.pointcloud.Marker`""" ) # Handle skip_invalid @@ -698,7 +700,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.pointcloud.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.pointcloud.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -853,7 +855,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pointcloud.Hoverlabel + an instance of + :class:`plotly.graph_objs.pointcloud.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -902,7 +905,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pointcloud.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.Hoverlabel""" +an instance of :class:`plotly.graph_objs.pointcloud.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/__init__.py index 61f71428186..cfa5660cbbd 100644 --- a/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.pointcloud.hoverlabel.Font + :class:`plotly.graph_objs.pointcloud.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.pointcloud.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.pointcloud.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/pointcloud/marker/__init__.py index 23474464303..9f34c3a462e 100644 --- a/packages/python/plotly/plotly/graph_objs/pointcloud/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/pointcloud/marker/__init__.py @@ -116,7 +116,7 @@ def __init__(self, arg=None, arearatio=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.pointcloud.marker.Border + :class:`plotly.graph_objs.pointcloud.marker.Border` arearatio Specifies what fraction of the marker area is covered with the border. @@ -145,7 +145,7 @@ def __init__(self, arg=None, arearatio=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.pointcloud.marker.Border constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.marker.Border""" +an instance of :class:`plotly.graph_objs.pointcloud.marker.Border`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sankey/__init__.py b/packages/python/plotly/plotly/graph_objs/sankey/__init__.py index 06ccec80b74..4cd79bd6d96 100644 --- a/packages/python/plotly/plotly/graph_objs/sankey/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sankey/__init__.py @@ -151,7 +151,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Textfont + an instance of + :class:`plotly.graph_objs.sankey.Textfont` color family @@ -190,7 +191,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.sankey.Textfont constructor must be a dict or -an instance of plotly.graph_objs.sankey.Textfont""" +an instance of :class:`plotly.graph_objs.sankey.Textfont`""" ) # Handle skip_invalid @@ -304,7 +305,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Stream + an instance of :class:`plotly.graph_objs.sankey.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -334,7 +335,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.sankey.Stream constructor must be a dict or -an instance of plotly.graph_objs.sankey.Stream""" +an instance of :class:`plotly.graph_objs.sankey.Stream`""" ) # Handle skip_invalid @@ -512,7 +513,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.sankey.node.Hoverlabel + - An instance of :class:`plotly.graph_objs.sankey.node.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -672,7 +673,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.sankey.node.Line + - An instance of :class:`plotly.graph_objs.sankey.node.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -851,8 +852,8 @@ def _prop_descriptions(self): displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.node.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sankey.node.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -885,8 +886,8 @@ def _prop_descriptions(self): labelsrc Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.node.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.node.Line` instance + or dict with compatible properties pad Sets the padding (in px) between the `nodes`. thickness @@ -931,7 +932,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Node + an instance of :class:`plotly.graph_objs.sankey.Node` color Sets the `node` color. It can be a single value, or an array for specifying color for each `node`. If @@ -951,8 +952,8 @@ def __init__( displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.node.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sankey.node.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -985,8 +986,8 @@ def __init__( labelsrc Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.node.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.node.Line` instance + or dict with compatible properties pad Sets the padding (in px) between the `nodes`. thickness @@ -1019,7 +1020,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.Node constructor must be a dict or -an instance of plotly.graph_objs.sankey.Node""" +an instance of :class:`plotly.graph_objs.sankey.Node`""" ) # Handle skip_invalid @@ -1241,7 +1242,7 @@ def colorscaledefaults(self): The 'colorscaledefaults' property is an instance of Colorscale that may be specified as: - - An instance of plotly.graph_objs.sankey.link.Colorscale + - An instance of :class:`plotly.graph_objs.sankey.link.Colorscale` - A dict of string/value properties that will be passed to the Colorscale constructor @@ -1308,7 +1309,7 @@ def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - - An instance of plotly.graph_objs.sankey.link.Hoverlabel + - An instance of :class:`plotly.graph_objs.sankey.link.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor @@ -1468,7 +1469,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.sankey.link.Line + - An instance of :class:`plotly.graph_objs.sankey.link.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1636,7 +1637,8 @@ def _prop_descriptions(self): `link.color` is omitted, then by default, a translucent grey link will be used. colorscales - A tuple of plotly.graph_objects.sankey.link.Colorscale + A tuple of + :class:`plotly.graph_objects.sankey.link.Colorscale` instances or dicts with compatible properties colorscaledefaults When used in a template (as @@ -1651,8 +1653,8 @@ def _prop_descriptions(self): displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.link.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sankey.link.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -1685,8 +1687,8 @@ def _prop_descriptions(self): labelsrc Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.link.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.link.Line` instance + or dict with compatible properties source An integer number `[0..nodes.length - 1]` that represents the source node. @@ -1734,14 +1736,15 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Link + an instance of :class:`plotly.graph_objs.sankey.Link` color Sets the `link` color. It can be a single value, or an array for specifying color for each `link`. If `link.color` is omitted, then by default, a translucent grey link will be used. colorscales - A tuple of plotly.graph_objects.sankey.link.Colorscale + A tuple of + :class:`plotly.graph_objects.sankey.link.Colorscale` instances or dicts with compatible properties colorscaledefaults When used in a template (as @@ -1756,8 +1759,8 @@ def __init__( displayed upon hovering. But, if `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.link.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.sankey.link.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that this will override @@ -1790,8 +1793,8 @@ def __init__( labelsrc Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.link.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.sankey.link.Line` instance + or dict with compatible properties source An integer number `[0..nodes.length - 1]` that represents the source node. @@ -1826,7 +1829,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.Link constructor must be a dict or -an instance of plotly.graph_objs.sankey.Link""" +an instance of :class:`plotly.graph_objs.sankey.Link`""" ) # Handle skip_invalid @@ -2126,7 +2129,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.sankey.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.sankey.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2281,7 +2284,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Hoverlabel + an instance of + :class:`plotly.graph_objs.sankey.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2330,7 +2334,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.sankey.Hoverlabel""" +an instance of :class:`plotly.graph_objs.sankey.Hoverlabel`""" ) # Handle skip_invalid @@ -2518,7 +2522,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Domain + an instance of :class:`plotly.graph_objs.sankey.Domain` column If there is a layout grid, use the domain for this column in the grid for this sankey trace . @@ -2551,7 +2555,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.sankey.Domain constructor must be a dict or -an instance of plotly.graph_objs.sankey.Domain""" +an instance of :class:`plotly.graph_objs.sankey.Domain`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/__init__.py index f8d4e6709d5..4c4a85bb367 100644 --- a/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.sankey.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.sankey.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.sankey.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sankey/link/__init__.py b/packages/python/plotly/plotly/graph_objs/sankey/link/__init__.py index 3581950ea3c..467b904c30e 100644 --- a/packages/python/plotly/plotly/graph_objs/sankey/link/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sankey/link/__init__.py @@ -157,7 +157,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.link.Line + an instance of + :class:`plotly.graph_objs.sankey.link.Line` color Sets the color of the `line` around each `link`. colorsrc @@ -187,7 +188,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.link.Line constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.Line""" +an instance of :class:`plotly.graph_objs.sankey.link.Line`""" ) # Handle skip_invalid @@ -444,7 +445,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.sankey.link.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -599,7 +600,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.link.Hoverlabel + an instance of + :class:`plotly.graph_objs.sankey.link.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -648,7 +650,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.link.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.Hoverlabel""" +an instance of :class:`plotly.graph_objs.sankey.link.Hoverlabel`""" ) # Handle skip_invalid @@ -945,7 +947,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.link.Colorscale + an instance of + :class:`plotly.graph_objs.sankey.link.Colorscale` cmax Sets the upper bound of the color domain. cmin @@ -1004,7 +1007,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.link.Colorscale constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.Colorscale""" +an instance of :class:`plotly.graph_objs.sankey.link.Colorscale`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/__init__.py index a552099620a..8494f1a9083 100644 --- a/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.sankey.link.hoverlabel.Font + :class:`plotly.graph_objs.sankey.link.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.link.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sankey/node/__init__.py b/packages/python/plotly/plotly/graph_objs/sankey/node/__init__.py index bdf5767e8cc..0d0827d770f 100644 --- a/packages/python/plotly/plotly/graph_objs/sankey/node/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sankey/node/__init__.py @@ -157,7 +157,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.node.Line + an instance of + :class:`plotly.graph_objs.sankey.node.Line` color Sets the color of the `line` around each `node`. colorsrc @@ -187,7 +188,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.node.Line constructor must be a dict or -an instance of plotly.graph_objs.sankey.node.Line""" +an instance of :class:`plotly.graph_objs.sankey.node.Line`""" ) # Handle skip_invalid @@ -444,7 +445,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.sankey.node.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.sankey.node.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -599,7 +600,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.node.Hoverlabel + an instance of + :class:`plotly.graph_objs.sankey.node.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -648,7 +650,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.node.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.sankey.node.Hoverlabel""" +an instance of :class:`plotly.graph_objs.sankey.node.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/__init__.py index 4e3ffd672c0..dcbd0bb2b5d 100644 --- a/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.sankey.node.hoverlabel.Font + :class:`plotly.graph_objs.sankey.node.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sankey.node.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.sankey.node.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.sankey.node.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/__init__.py index b1548593def..9725271afba 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatter.unselected.Marker + - An instance of :class:`plotly.graph_objs.scatter.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatter.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scatter.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatter.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.scatter.unselected.Textfont + :class:`plotly.graph_objects.scatter.unselected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatter.unselected.Textfon + t` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -91,13 +91,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Unselected + an instance of + :class:`plotly.graph_objs.scatter.Unselected` marker - plotly.graph_objects.scatter.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.scatter.unselected.Textfont + :class:`plotly.graph_objects.scatter.unselected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatter.unselected.Textfon + t` instance or dict with compatible properties Returns ------- @@ -118,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scatter.Unselected""" +an instance of :class:`plotly.graph_objs.scatter.Unselected`""" ) # Handle skip_invalid @@ -382,7 +383,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Textfont + an instance of + :class:`plotly.graph_objs.scatter.Textfont` color colorsrc @@ -427,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatter.Textfont""" +an instance of :class:`plotly.graph_objs.scatter.Textfont`""" ) # Handle skip_invalid @@ -550,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Stream + an instance of + :class:`plotly.graph_objs.scatter.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -580,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.Stream constructor must be a dict or -an instance of plotly.graph_objs.scatter.Stream""" +an instance of :class:`plotly.graph_objs.scatter.Stream`""" ) # Handle skip_invalid @@ -625,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatter.selected.Marker + - An instance of :class:`plotly.graph_objs.scatter.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -655,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatter.selected.Textfont + - An instance of :class:`plotly.graph_objs.scatter.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -686,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatter.selected.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.Marker` + instance or dict with compatible properties textfont - plotly.graph_objects.scatter.selected.Textfont instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.Textfont` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -701,13 +704,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Selected + an instance of + :class:`plotly.graph_objs.scatter.Selected` marker - plotly.graph_objects.scatter.selected.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.Marker` + instance or dict with compatible properties textfont - plotly.graph_objects.scatter.selected.Textfont instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.Textfont` + instance or dict with compatible properties Returns ------- @@ -728,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.Selected constructor must be a dict or -an instance of plotly.graph_objs.scatter.Selected""" +an instance of :class:`plotly.graph_objs.scatter.Selected`""" ) # Handle skip_invalid @@ -986,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scatter.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1118,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter.marker. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.scatter + .marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatter.marker.colorbar.tickformatstopdefault @@ -1167,8 +1171,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter.marker.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use scatter.marker.colorbar.title.font instead. @@ -1294,7 +1299,7 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.Gradient + - An instance of :class:`plotly.graph_objs.scatter.marker.Gradient` - A dict of string/value properties that will be passed to the Gradient constructor @@ -1331,7 +1336,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.Line + - An instance of :class:`plotly.graph_objs.scatter.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1814,8 +1819,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1833,11 +1838,11 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatter.marker.Gradient instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Gradient` + instance or dict with compatible properties line - plotly.graph_objects.scatter.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Line` + instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -1918,7 +1923,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Marker + an instance of + :class:`plotly.graph_objs.scatter.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1966,8 +1972,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1985,11 +1991,11 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatter.marker.Gradient instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Gradient` + instance or dict with compatible properties line - plotly.graph_objects.scatter.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Line` + instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -2052,7 +2058,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatter.Marker""" +an instance of :class:`plotly.graph_objs.scatter.Marker`""" ) # Handle skip_invalid @@ -2382,7 +2388,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Line + an instance of :class:`plotly.graph_objs.scatter.Line` color Sets the line color. dash @@ -2425,7 +2431,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.Line constructor must be a dict or -an instance of plotly.graph_objs.scatter.Line""" +an instance of :class:`plotly.graph_objs.scatter.Line`""" ) # Handle skip_invalid @@ -2688,7 +2694,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scatter.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2843,7 +2849,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Hoverlabel + an instance of + :class:`plotly.graph_objs.scatter.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2892,7 +2899,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scatter.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scatter.Hoverlabel`""" ) # Handle skip_invalid @@ -3376,7 +3383,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.ErrorY + an instance of + :class:`plotly.graph_objs.scatter.ErrorY` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3448,7 +3456,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.ErrorY constructor must be a dict or -an instance of plotly.graph_objs.scatter.ErrorY""" +an instance of :class:`plotly.graph_objs.scatter.ErrorY`""" ) # Handle skip_invalid @@ -3968,7 +3976,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.ErrorX + an instance of + :class:`plotly.graph_objs.scatter.ErrorX` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -4042,7 +4051,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.ErrorX constructor must be a dict or -an instance of plotly.graph_objs.scatter.ErrorX""" +an instance of :class:`plotly.graph_objs.scatter.ErrorX`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/__init__.py index f95e46c275a..7341bf7db4a 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.hoverlabel.Font + :class:`plotly.graph_objs.scatter.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scatter.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scatter.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/__init__.py index 0a01583a3ec..bea768d9178 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.marker.Line + an instance of + :class:`plotly.graph_objs.scatter.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.Line""" +an instance of :class:`plotly.graph_objs.scatter.marker.Line`""" ) # Handle skip_invalid @@ -794,7 +795,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.marker.Gradient + :class:`plotly.graph_objs.scatter.marker.Gradient` color Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the @@ -825,7 +826,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.marker.Gradient constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.Gradient""" +an instance of :class:`plotly.graph_objs.scatter.marker.Gradient`""" ) # Handle skip_invalid @@ -1490,7 +1491,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1624,7 +1625,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1862,7 +1863,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1906,7 +1907,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2215,9 +2216,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter.marker.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatter.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte r.marker.colorbar.tickformatstopdefaults), sets the @@ -2257,8 +2258,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use scatter.marker.colorbar.title.font instead. Sets this @@ -2353,7 +2354,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.marker.ColorBar + :class:`plotly.graph_objs.scatter.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2466,9 +2467,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter.marker.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatter.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte r.marker.colorbar.tickformatstopdefaults), sets the @@ -2508,8 +2509,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use scatter.marker.colorbar.title.font instead. Sets this @@ -2561,7 +2562,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scatter.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/__init__.py index 380b98717ab..b8d6b1761f6 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.marker.colorba - r.Tickformatstop + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py index 423237dc9b3..40f192aeda7 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/selected/__init__.py index a5c3571784e..efeaf0ee29f 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/selected/__init__.py @@ -87,7 +87,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.selected.Textfont + :class:`plotly.graph_objs.scatter.selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatter.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scatter.selected.Textfont`""" ) # Handle skip_invalid @@ -272,7 +272,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.selected.Marker + :class:`plotly.graph_objs.scatter.selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatter.selected.Marker""" +an instance of :class:`plotly.graph_objs.scatter.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter/unselected/__init__.py index c3715d099b4..c9de8c025a0 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter/unselected/__init__.py @@ -89,7 +89,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.unselected.Textfont + :class:`plotly.graph_objs.scatter.unselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatter.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scatter.unselected.Textfont`""" ) # Handle skip_invalid @@ -281,7 +281,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter.unselected.Marker + :class:`plotly.graph_objs.scatter.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatter.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scatter.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/__init__.py index e1195631b68..d1d69f58f18 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/__init__.py @@ -204,7 +204,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Textfont + an instance of + :class:`plotly.graph_objs.scatter3d.Textfont` color colorsrc @@ -247,7 +248,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Textfont""" +an instance of :class:`plotly.graph_objs.scatter3d.Textfont`""" ) # Handle skip_invalid @@ -367,7 +368,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Stream + an instance of + :class:`plotly.graph_objs.scatter3d.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -397,7 +399,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.Stream constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Stream""" +an instance of :class:`plotly.graph_objs.scatter3d.Stream`""" ) # Handle skip_invalid @@ -442,7 +444,7 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of plotly.graph_objs.scatter3d.projection.X + - An instance of :class:`plotly.graph_objs.scatter3d.projection.X` - A dict of string/value properties that will be passed to the X constructor @@ -474,7 +476,7 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of plotly.graph_objs.scatter3d.projection.Y + - An instance of :class:`plotly.graph_objs.scatter3d.projection.Y` - A dict of string/value properties that will be passed to the Y constructor @@ -506,7 +508,7 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of plotly.graph_objs.scatter3d.projection.Z + - An instance of :class:`plotly.graph_objs.scatter3d.projection.Z` - A dict of string/value properties that will be passed to the Z constructor @@ -543,14 +545,14 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ x - plotly.graph_objects.scatter3d.projection.X instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projection.X` + instance or dict with compatible properties y - plotly.graph_objects.scatter3d.projection.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projection.Y` + instance or dict with compatible properties z - plotly.graph_objects.scatter3d.projection.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projection.Z` + instance or dict with compatible properties """ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): @@ -561,16 +563,17 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Projection + an instance of + :class:`plotly.graph_objs.scatter3d.Projection` x - plotly.graph_objects.scatter3d.projection.X instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projection.X` + instance or dict with compatible properties y - plotly.graph_objects.scatter3d.projection.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projection.Y` + instance or dict with compatible properties z - plotly.graph_objects.scatter3d.projection.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projection.Z` + instance or dict with compatible properties Returns ------- @@ -591,7 +594,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.Projection constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Projection""" +an instance of :class:`plotly.graph_objs.scatter3d.Projection`""" ) # Handle skip_invalid @@ -852,7 +855,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scatter3d.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -984,9 +987,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.marke - r.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + 3d.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatter3d.marker.colorbar.tickformatstopdefau @@ -1033,8 +1036,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.marker.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.scatter3d.marker.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -1161,7 +1164,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.Line + - An instance of :class:`plotly.graph_objs.scatter3d.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1541,8 +1544,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1560,8 +1563,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatter3d.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for @@ -1634,7 +1637,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Marker + an instance of + :class:`plotly.graph_objs.scatter3d.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1682,8 +1686,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1701,8 +1705,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatter3d.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for @@ -1760,7 +1764,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Marker""" +an instance of :class:`plotly.graph_objs.scatter3d.Marker`""" ) # Handle skip_invalid @@ -2074,7 +2078,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scatter3d.line.ColorBar + - An instance of :class:`plotly.graph_objs.scatter3d.line.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -2206,9 +2210,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.line. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.scatter + 3d.line.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatter3d.line.colorbar.tickformatstopdefault @@ -2255,8 +2259,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.line.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use scatter3d.line.colorbar.title.font instead. @@ -2520,8 +2525,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.line.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale @@ -2580,7 +2585,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Line + an instance of + :class:`plotly.graph_objs.scatter3d.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -2628,8 +2634,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.line.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale @@ -2680,7 +2686,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.Line constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Line""" +an instance of :class:`plotly.graph_objs.scatter3d.Line`""" ) # Handle skip_invalid @@ -2967,7 +2973,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter3d.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scatter3d.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -3122,7 +3128,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Hoverlabel + an instance of + :class:`plotly.graph_objs.scatter3d.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -3171,7 +3178,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel`""" ) # Handle skip_invalid @@ -3655,7 +3662,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.ErrorZ + an instance of + :class:`plotly.graph_objs.scatter3d.ErrorZ` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3727,7 +3735,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.ErrorZ constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.ErrorZ""" +an instance of :class:`plotly.graph_objs.scatter3d.ErrorZ`""" ) # Handle skip_invalid @@ -4247,7 +4255,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.ErrorY + an instance of + :class:`plotly.graph_objs.scatter3d.ErrorY` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -4321,7 +4330,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.ErrorY constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.ErrorY""" +an instance of :class:`plotly.graph_objs.scatter3d.ErrorY`""" ) # Handle skip_invalid @@ -4844,7 +4853,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.ErrorX + an instance of + :class:`plotly.graph_objs.scatter3d.ErrorX` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -4918,7 +4928,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.ErrorX constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.ErrorX""" +an instance of :class:`plotly.graph_objs.scatter3d.ErrorX`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/__init__.py index 37af5e9f335..a5a1b1781f5 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter3d.hoverlabel.Font + :class:`plotly.graph_objs.scatter3d.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scatter3d.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/__init__.py index d35f51ad5c1..f5787793d43 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/__init__.py @@ -625,7 +625,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scatter3d.line.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -759,7 +759,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -997,7 +997,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scatter3d.line.colorbar.Title + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1041,7 +1041,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter3d.line.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1350,9 +1350,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.line.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatter3d.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte r3d.line.colorbar.tickformatstopdefaults), sets the @@ -1392,8 +1392,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.line.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use scatter3d.line.colorbar.title.font instead. Sets this @@ -1488,7 +1488,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter3d.line.ColorBar + :class:`plotly.graph_objs.scatter3d.line.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -1601,9 +1601,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.line.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatter3d.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte r3d.line.colorbar.tickformatstopdefaults), sets the @@ -1643,8 +1643,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.line.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use scatter3d.line.colorbar.title.font instead. Sets this @@ -1696,7 +1696,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.line.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.line.ColorBar""" +an instance of :class:`plotly.graph_objs.scatter3d.line.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/__init__.py index 4f3aa0d497c..1b860820105 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter3d.line.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.line.colorbar.Title + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.line.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.line.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.line.colorba - r.Tickformatstop + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.line.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.line.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.line.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py index 31825d6cc99..dda2c18ed33 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.line.colorbar.title.Font + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.line.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.line.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/__init__.py index 3298a9bc70c..88c4afd4a9c 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/__init__.py @@ -447,7 +447,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.marker.Line + an instance of + :class:`plotly.graph_objs.scatter3d.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -543,7 +544,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.Line""" +an instance of :class:`plotly.graph_objs.scatter3d.marker.Line`""" ) # Handle skip_invalid @@ -1229,7 +1230,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1363,7 +1364,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1601,7 +1602,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1645,7 +1646,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1954,9 +1955,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.marker.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatter3d.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte r3d.marker.colorbar.tickformatstopdefaults), sets the @@ -1996,8 +1997,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use scatter3d.marker.colorbar.title.font instead. Sets this @@ -2093,7 +2094,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatter3d.marker.ColorBar + :class:`plotly.graph_objs.scatter3d.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2206,9 +2207,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.marker.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatter3d.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte r3d.marker.colorbar.tickformatstopdefaults), sets the @@ -2248,8 +2249,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use scatter3d.marker.colorbar.title.font instead. Sets this @@ -2302,7 +2303,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scatter3d.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py index db0a9d3aae2..35f5765dd83 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatter3d.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.marker.color - bar.Tickformatstop + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py index bfd27f807f4..bf0974062bb 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/__init__.py b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/__init__.py index b5bdb4afc57..9c4eca13cd9 100644 --- a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/__init__.py @@ -94,7 +94,8 @@ def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.projection.Z + an instance of + :class:`plotly.graph_objs.scatter3d.projection.Z` opacity Sets the projection color. scale @@ -123,7 +124,7 @@ def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.projection.Z constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.projection.Z""" +an instance of :class:`plotly.graph_objs.scatter3d.projection.Z`""" ) # Handle skip_invalid @@ -254,7 +255,8 @@ def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.projection.Y + an instance of + :class:`plotly.graph_objs.scatter3d.projection.Y` opacity Sets the projection color. scale @@ -283,7 +285,7 @@ def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.projection.Y constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.projection.Y""" +an instance of :class:`plotly.graph_objs.scatter3d.projection.Y`""" ) # Handle skip_invalid @@ -414,7 +416,8 @@ def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.projection.X + an instance of + :class:`plotly.graph_objs.scatter3d.projection.X` opacity Sets the projection color. scale @@ -443,7 +446,7 @@ def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatter3d.projection.X constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.projection.X""" +an instance of :class:`plotly.graph_objs.scatter3d.projection.X`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/__init__.py index f412ff5fce0..b40625b6638 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.unselected.Marker + - An instance of :class:`plotly.graph_objs.scattercarpet.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scattercarpet.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattercarpet.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.unselected.M + arker` instance or dict with compatible properties textfont - plotly.graph_objects.scattercarpet.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.unselected.T + extfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -92,13 +92,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattercarpet.Unselected + :class:`plotly.graph_objs.scattercarpet.Unselected` marker - plotly.graph_objects.scattercarpet.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.unselected.M + arker` instance or dict with compatible properties textfont - plotly.graph_objects.scattercarpet.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.unselected.T + extfont` instance or dict with compatible properties Returns ------- @@ -119,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Unselected""" +an instance of :class:`plotly.graph_objs.scattercarpet.Unselected`""" ) # Handle skip_invalid @@ -383,7 +383,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Textfont + an instance of + :class:`plotly.graph_objs.scattercarpet.Textfont` color colorsrc @@ -428,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Textfont""" +an instance of :class:`plotly.graph_objs.scattercarpet.Textfont`""" ) # Handle skip_invalid @@ -551,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Stream + an instance of + :class:`plotly.graph_objs.scattercarpet.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -581,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.Stream constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Stream""" +an instance of :class:`plotly.graph_objs.scattercarpet.Stream`""" ) # Handle skip_invalid @@ -626,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.selected.Marker + - An instance of :class:`plotly.graph_objs.scattercarpet.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -656,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.selected.Textfont + - An instance of :class:`plotly.graph_objs.scattercarpet.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -687,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattercarpet.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.selected.Mar + ker` instance or dict with compatible properties textfont - plotly.graph_objects.scattercarpet.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.selected.Tex + tfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -702,13 +704,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Selected + an instance of + :class:`plotly.graph_objs.scattercarpet.Selected` marker - plotly.graph_objects.scattercarpet.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.selected.Mar + ker` instance or dict with compatible properties textfont - plotly.graph_objects.scattercarpet.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.selected.Tex + tfont` instance or dict with compatible properties Returns ------- @@ -729,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.Selected constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Selected""" +an instance of :class:`plotly.graph_objs.scattercarpet.Selected`""" ) # Handle skip_invalid @@ -987,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1119,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattercarpet.m - arker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + carpet.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattercarpet.marker.colorbar.tickformatstopd @@ -1168,9 +1171,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattercarpet.marker.color - bar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scattercarpet.mark + er.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scattercarpet.marker.colorbar.title.font @@ -1296,7 +1299,7 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.Gradient + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.Gradient` - A dict of string/value properties that will be passed to the Gradient constructor @@ -1333,7 +1336,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.Line + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1816,8 +1819,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattercarpet.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.Color + Bar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1835,11 +1838,11 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattercarpet.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.Gradi + ent` instance or dict with compatible properties line - plotly.graph_objects.scattercarpet.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.Line` + instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -1920,7 +1923,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Marker + an instance of + :class:`plotly.graph_objs.scattercarpet.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1968,8 +1972,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattercarpet.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.Color + Bar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1987,11 +1991,11 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattercarpet.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.Gradi + ent` instance or dict with compatible properties line - plotly.graph_objects.scattercarpet.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.Line` + instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -2054,7 +2058,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Marker""" +an instance of :class:`plotly.graph_objs.scattercarpet.Marker`""" ) # Handle skip_invalid @@ -2355,7 +2359,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Line + an instance of + :class:`plotly.graph_objs.scattercarpet.Line` color Sets the line color. dash @@ -2393,7 +2398,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.Line constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Line""" +an instance of :class:`plotly.graph_objs.scattercarpet.Line`""" ) # Handle skip_invalid @@ -2653,7 +2658,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scattercarpet.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2809,7 +2814,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattercarpet.Hoverlabel + :class:`plotly.graph_objs.scattercarpet.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2858,7 +2863,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py index bd4773a0492..bc9fa592850 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.hoverlabel.Font + an instance of :class:`plotly.graph_objs.scattercarpet. + hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scattercarpet.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/__init__.py index 34caaadd139..6788b25ec75 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/__init__.py @@ -472,7 +472,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattercarpet.marker.Line + :class:`plotly.graph_objs.scattercarpet.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -570,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.Line""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.Line`""" ) # Handle skip_invalid @@ -794,8 +794,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.Gradient + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.Gradient` color Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the @@ -826,7 +826,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.marker.Gradient constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.Gradient""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.Gradient`""" ) # Handle skip_invalid @@ -1491,7 +1491,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1625,7 +1625,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1863,7 +1863,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1907,7 +1907,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2216,8 +2216,8 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattercarpet.marker.co - lorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scattercarpet.m + arker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -2258,8 +2258,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattercarpet.marker.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.color + bar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scattercarpet.marker.colorbar.title.font instead. Sets @@ -2355,8 +2355,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.ColorBar + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2469,8 +2469,8 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattercarpet.marker.co - lorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scattercarpet.m + arker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -2511,8 +2511,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattercarpet.marker.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.marker.color + bar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scattercarpet.marker.colorbar.title.font instead. Sets @@ -2566,7 +2566,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py index 89718ff03e0..23e618da7be 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.marker.c - olorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.marker.c - olorbar.Tickfont + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py index 109402b7aa8..c9737dcc34e 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.marker.c - olorbar.title.Font + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/__init__.py index e0afe6c8c3d..8749098959c 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/__init__.py @@ -86,8 +86,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.selected.Textfont + an instance of :class:`plotly.graph_objs.scattercarpet. + selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scattercarpet.selected.Textfont`""" ) # Handle skip_invalid @@ -271,8 +271,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.selected.Marker + an instance of :class:`plotly.graph_objs.scattercarpet. + selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.selected.Marker""" +an instance of :class:`plotly.graph_objs.scattercarpet.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/__init__.py index 270d6e4fdb3..96c4a9730a2 100644 --- a/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.unselected.Textfont + an instance of :class:`plotly.graph_objs.scattercarpet. + unselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scattercarpet.unselected.Textfont`""" ) # Handle skip_invalid @@ -280,8 +280,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.unselected.Marker + an instance of :class:`plotly.graph_objs.scattercarpet. + unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattercarpet.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scattercarpet.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/__init__.py index c5c8e729ec4..87f18ad8428 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattergeo.unselected.Marker + - An instance of :class:`plotly.graph_objs.scattergeo.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattergeo.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scattergeo.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattergeo.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.unselected.Mark + er` instance or dict with compatible properties textfont - plotly.graph_objects.scattergeo.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.unselected.Text + font` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -91,13 +91,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Unselected + an instance of + :class:`plotly.graph_objs.scattergeo.Unselected` marker - plotly.graph_objects.scattergeo.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.unselected.Mark + er` instance or dict with compatible properties textfont - plotly.graph_objects.scattergeo.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.unselected.Text + font` instance or dict with compatible properties Returns ------- @@ -118,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Unselected""" +an instance of :class:`plotly.graph_objs.scattergeo.Unselected`""" ) # Handle skip_invalid @@ -382,7 +383,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Textfont + an instance of + :class:`plotly.graph_objs.scattergeo.Textfont` color colorsrc @@ -427,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Textfont""" +an instance of :class:`plotly.graph_objs.scattergeo.Textfont`""" ) # Handle skip_invalid @@ -550,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Stream + an instance of + :class:`plotly.graph_objs.scattergeo.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -580,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.Stream constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Stream""" +an instance of :class:`plotly.graph_objs.scattergeo.Stream`""" ) # Handle skip_invalid @@ -625,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattergeo.selected.Marker + - An instance of :class:`plotly.graph_objs.scattergeo.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -655,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattergeo.selected.Textfont + - An instance of :class:`plotly.graph_objs.scattergeo.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -686,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattergeo.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selected.Marker + ` instance or dict with compatible properties textfont - plotly.graph_objects.scattergeo.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selected.Textfo + nt` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -701,13 +704,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Selected + an instance of + :class:`plotly.graph_objs.scattergeo.Selected` marker - plotly.graph_objects.scattergeo.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selected.Marker + ` instance or dict with compatible properties textfont - plotly.graph_objects.scattergeo.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selected.Textfo + nt` instance or dict with compatible properties Returns ------- @@ -728,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.Selected constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Selected""" +an instance of :class:`plotly.graph_objs.scattergeo.Selected`""" ) # Handle skip_invalid @@ -986,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scattergeo.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1118,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergeo.mark - er.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + geo.marker.colorbar.Tickformatstop` instances + or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattergeo.marker.colorbar.tickformatstopdefa @@ -1167,9 +1171,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergeo.marker.colorbar - .Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scattergeo.marker. + colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scattergeo.marker.colorbar.title.font instead. @@ -1295,7 +1299,7 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.Gradient + - An instance of :class:`plotly.graph_objs.scattergeo.marker.Gradient` - A dict of string/value properties that will be passed to the Gradient constructor @@ -1332,7 +1336,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.Line + - An instance of :class:`plotly.graph_objs.scattergeo.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1794,8 +1798,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergeo.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.ColorBar + ` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1813,11 +1817,11 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattergeo.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.Gradient + ` instance or dict with compatible properties line - plotly.graph_objects.scattergeo.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1894,7 +1898,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Marker + an instance of + :class:`plotly.graph_objs.scattergeo.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1942,8 +1947,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergeo.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.ColorBar + ` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1961,11 +1966,11 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattergeo.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.Gradient + ` instance or dict with compatible properties line - plotly.graph_objects.scattergeo.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -2025,7 +2030,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Marker""" +an instance of :class:`plotly.graph_objs.scattergeo.Marker`""" ) # Handle skip_invalid @@ -2261,7 +2266,8 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Line + an instance of + :class:`plotly.graph_objs.scattergeo.Line` color Sets the line color. dash @@ -2291,7 +2297,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.Line constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Line""" +an instance of :class:`plotly.graph_objs.scattergeo.Line`""" ) # Handle skip_invalid @@ -2545,7 +2551,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattergeo.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scattergeo.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2700,7 +2706,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Hoverlabel + an instance of + :class:`plotly.graph_objs.scattergeo.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2749,7 +2756,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/__init__.py index 91f10c9cdc8..d9cd87abf67 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergeo.hoverlabel.Font + :class:`plotly.graph_objs.scattergeo.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scattergeo.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/__init__.py index 37436fd3550..999bb396237 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.marker.Line + an instance of + :class:`plotly.graph_objs.scattergeo.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.Line""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.Line`""" ) # Handle skip_invalid @@ -794,7 +795,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergeo.marker.Gradient + :class:`plotly.graph_objs.scattergeo.marker.Gradient` color Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the @@ -825,7 +826,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.marker.Gradient constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.Gradient""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.Gradient`""" ) # Handle skip_invalid @@ -1490,7 +1491,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1624,7 +1625,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1862,7 +1863,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1906,7 +1907,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2215,9 +2216,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergeo.marker.color - bar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scattergeo.mark + er.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte rgeo.marker.colorbar.tickformatstopdefaults), sets the @@ -2257,8 +2258,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergeo.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.colorbar + .Title` instance or dict with compatible properties titlefont Deprecated: Please use scattergeo.marker.colorbar.title.font instead. Sets @@ -2355,7 +2356,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergeo.marker.ColorBar + :class:`plotly.graph_objs.scattergeo.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2468,9 +2469,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergeo.marker.color - bar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scattergeo.mark + er.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte rgeo.marker.colorbar.tickformatstopdefaults), sets the @@ -2510,8 +2511,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergeo.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker.colorbar + .Title` instance or dict with compatible properties titlefont Deprecated: Please use scattergeo.marker.colorbar.title.font instead. Sets @@ -2565,7 +2566,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py index 671827a013c..77da5f25cf8 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattergeo.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.marker.colo - rbar.Tickformatstop + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py index 0d22b1cad73..77d32735873 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/selected/__init__.py index 5603a834afb..f76aabb038a 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/selected/__init__.py @@ -87,7 +87,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergeo.selected.Textfont + :class:`plotly.graph_objs.scattergeo.selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scattergeo.selected.Textfont`""" ) # Handle skip_invalid @@ -272,7 +272,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergeo.selected.Marker + :class:`plotly.graph_objs.scattergeo.selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.selected.Marker""" +an instance of :class:`plotly.graph_objs.scattergeo.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/__init__.py index fe888453361..76c502e425e 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.unselected.Textfont + an instance of :class:`plotly.graph_objs.scattergeo.uns + elected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scattergeo.unselected.Textfont`""" ) # Handle skip_invalid @@ -281,7 +281,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergeo.unselected.Marker + :class:`plotly.graph_objs.scattergeo.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergeo.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scattergeo.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/__init__.py index c1c71007890..83e0a6c74ac 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattergl.unselected.Marker + - An instance of :class:`plotly.graph_objs.scattergl.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattergl.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scattergl.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattergl.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselected.Marke + r` instance or dict with compatible properties textfont - plotly.graph_objects.scattergl.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselected.Textf + ont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -91,13 +91,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Unselected + an instance of + :class:`plotly.graph_objs.scattergl.Unselected` marker - plotly.graph_objects.scattergl.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselected.Marke + r` instance or dict with compatible properties textfont - plotly.graph_objects.scattergl.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselected.Textf + ont` instance or dict with compatible properties Returns ------- @@ -118,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Unselected""" +an instance of :class:`plotly.graph_objs.scattergl.Unselected`""" ) # Handle skip_invalid @@ -382,7 +383,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Textfont + an instance of + :class:`plotly.graph_objs.scattergl.Textfont` color colorsrc @@ -427,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Textfont""" +an instance of :class:`plotly.graph_objs.scattergl.Textfont`""" ) # Handle skip_invalid @@ -550,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Stream + an instance of + :class:`plotly.graph_objs.scattergl.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -580,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.Stream constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Stream""" +an instance of :class:`plotly.graph_objs.scattergl.Stream`""" ) # Handle skip_invalid @@ -625,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattergl.selected.Marker + - An instance of :class:`plotly.graph_objs.scattergl.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -655,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scattergl.selected.Textfont + - An instance of :class:`plotly.graph_objs.scattergl.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -686,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattergl.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.scattergl.selected.Textfont + :class:`plotly.graph_objects.scattergl.selected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergl.selected.Textfon + t` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -701,13 +704,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Selected + an instance of + :class:`plotly.graph_objs.scattergl.Selected` marker - plotly.graph_objects.scattergl.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objects.scattergl.selected.Textfont + :class:`plotly.graph_objects.scattergl.selected.Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergl.selected.Textfon + t` instance or dict with compatible properties Returns ------- @@ -728,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.Selected constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Selected""" +an instance of :class:`plotly.graph_objs.scattergl.Selected`""" ) # Handle skip_invalid @@ -986,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scattergl.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1118,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergl.marke - r.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + gl.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattergl.marker.colorbar.tickformatstopdefau @@ -1167,8 +1171,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergl.marker.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.scattergl.marker.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -1295,7 +1299,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.Line + - An instance of :class:`plotly.graph_objs.scattergl.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1757,8 +1761,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergl.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1776,8 +1780,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.scattergl.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1853,7 +1857,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Marker + an instance of + :class:`plotly.graph_objs.scattergl.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1901,8 +1906,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergl.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1920,8 +1925,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.scattergl.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1981,7 +1986,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Marker""" +an instance of :class:`plotly.graph_objs.scattergl.Marker`""" ) # Handle skip_invalid @@ -2234,7 +2239,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Line + an instance of + :class:`plotly.graph_objs.scattergl.Line` color Sets the line color. dash @@ -2264,7 +2270,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.Line constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Line""" +an instance of :class:`plotly.graph_objs.scattergl.Line`""" ) # Handle skip_invalid @@ -2521,7 +2527,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattergl.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scattergl.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2676,7 +2682,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Hoverlabel + an instance of + :class:`plotly.graph_objs.scattergl.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2725,7 +2732,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scattergl.Hoverlabel`""" ) # Handle skip_invalid @@ -3209,7 +3216,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.ErrorY + an instance of + :class:`plotly.graph_objs.scattergl.ErrorY` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3281,7 +3289,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.ErrorY constructor must be a dict or -an instance of plotly.graph_objs.scattergl.ErrorY""" +an instance of :class:`plotly.graph_objs.scattergl.ErrorY`""" ) # Handle skip_invalid @@ -3801,7 +3809,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.ErrorX + an instance of + :class:`plotly.graph_objs.scattergl.ErrorX` array Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying @@ -3875,7 +3884,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.ErrorX constructor must be a dict or -an instance of plotly.graph_objs.scattergl.ErrorX""" +an instance of :class:`plotly.graph_objs.scattergl.ErrorX`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/__init__.py index 12f38520d9e..27dd6c885a6 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergl.hoverlabel.Font + :class:`plotly.graph_objs.scattergl.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scattergl.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scattergl.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/__init__.py index ef5524e8d3f..504fb806e46 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.marker.Line + an instance of + :class:`plotly.graph_objs.scattergl.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.Line""" +an instance of :class:`plotly.graph_objs.scattergl.marker.Line`""" ) # Handle skip_invalid @@ -1258,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1392,7 +1393,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1630,7 +1631,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1674,7 +1675,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1983,9 +1984,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergl.marker.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scattergl.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte rgl.marker.colorbar.tickformatstopdefaults), sets the @@ -2025,8 +2026,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergl.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use scattergl.marker.colorbar.title.font instead. Sets this @@ -2122,7 +2123,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergl.marker.ColorBar + :class:`plotly.graph_objs.scattergl.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2235,9 +2236,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergl.marker.colorb - ar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scattergl.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte rgl.marker.colorbar.tickformatstopdefaults), sets the @@ -2277,8 +2278,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergl.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.colorbar. + Title` instance or dict with compatible properties titlefont Deprecated: Please use scattergl.marker.colorbar.title.font instead. Sets this @@ -2331,7 +2332,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scattergl.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/__init__.py index 9dd2af3cc88..006960c1709 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattergl.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.marker.color - bar.Tickformatstop + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py index 13edd99e744..17166fc7626 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/selected/__init__.py index 37c24b98816..88c32f8d500 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/selected/__init__.py @@ -87,7 +87,7 @@ def __init__(self, arg=None, color=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergl.selected.Textfont + :class:`plotly.graph_objs.scattergl.selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattergl.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scattergl.selected.Textfont`""" ) # Handle skip_invalid @@ -272,7 +272,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergl.selected.Marker + :class:`plotly.graph_objs.scattergl.selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattergl.selected.Marker""" +an instance of :class:`plotly.graph_objs.scattergl.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattergl/unselected/__init__.py index 2d996bad0cd..81ece2ac027 100644 --- a/packages/python/plotly/plotly/graph_objs/scattergl/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattergl/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.unselected.Textfont + an instance of :class:`plotly.graph_objs.scattergl.unse + lected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattergl.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scattergl.unselected.Textfont`""" ) # Handle skip_invalid @@ -281,7 +281,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattergl.unselected.Marker + :class:`plotly.graph_objs.scattergl.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattergl.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattergl.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scattergl.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/__init__.py index 9609f388088..bd35e347a36 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.unselected.Marker + - An instance of :class:`plotly.graph_objs.scattermapbox.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -49,8 +49,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattermapbox.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.unselected.M + arker` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -62,10 +62,10 @@ def __init__(self, arg=None, marker=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattermapbox.Unselected + :class:`plotly.graph_objs.scattermapbox.Unselected` marker - plotly.graph_objects.scattermapbox.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.unselected.M + arker` instance or dict with compatible properties Returns ------- @@ -86,7 +86,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Unselected""" +an instance of :class:`plotly.graph_objs.scattermapbox.Unselected`""" ) # Handle skip_invalid @@ -270,7 +270,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Textfont + an instance of + :class:`plotly.graph_objs.scattermapbox.Textfont` color family @@ -309,7 +310,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Textfont""" +an instance of :class:`plotly.graph_objs.scattermapbox.Textfont`""" ) # Handle skip_invalid @@ -423,7 +424,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Stream + an instance of + :class:`plotly.graph_objs.scattermapbox.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -453,7 +455,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.Stream constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Stream""" +an instance of :class:`plotly.graph_objs.scattermapbox.Stream`""" ) # Handle skip_invalid @@ -498,7 +500,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.selected.Marker + - An instance of :class:`plotly.graph_objs.scattermapbox.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -533,8 +535,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scattermapbox.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.selected.Mar + ker` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -545,10 +547,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Selected + an instance of + :class:`plotly.graph_objs.scattermapbox.Selected` marker - plotly.graph_objects.scattermapbox.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.selected.Mar + ker` instance or dict with compatible properties Returns ------- @@ -569,7 +572,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.Selected constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Selected""" +an instance of :class:`plotly.graph_objs.scattermapbox.Selected`""" ) # Handle skip_invalid @@ -824,7 +827,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -956,9 +959,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattermapbox.m - arker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + mapbox.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattermapbox.marker.colorbar.tickformatstopd @@ -1005,9 +1008,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattermapbox.marker.color - bar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scattermapbox.mark + er.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scattermapbox.marker.colorbar.title.font @@ -1422,8 +1425,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattermapbox.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.marker.Color + Bar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1513,7 +1516,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Marker + an instance of + :class:`plotly.graph_objs.scattermapbox.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1561,8 +1565,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattermapbox.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.marker.Color + Bar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1637,7 +1641,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattermapbox.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Marker""" +an instance of :class:`plotly.graph_objs.scattermapbox.Marker`""" ) # Handle skip_invalid @@ -1836,7 +1840,8 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Line + an instance of + :class:`plotly.graph_objs.scattermapbox.Line` color Sets the line color. width @@ -1861,7 +1866,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.Line constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Line""" +an instance of :class:`plotly.graph_objs.scattermapbox.Line`""" ) # Handle skip_invalid @@ -2112,7 +2117,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scattermapbox.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2268,7 +2273,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scattermapbox.Hoverlabel + :class:`plotly.graph_objs.scattermapbox.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2317,7 +2322,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattermapbox.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py index 8081b5b5c07..dc1826f7c04 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.hoverlabel.Font + an instance of :class:`plotly.graph_objs.scattermapbox. + hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattermapbox.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scattermapbox.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/__init__.py index 808f647cf67..71c090e4348 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/__init__.py @@ -625,7 +625,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -759,7 +759,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -997,7 +997,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1041,7 +1041,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1350,8 +1350,8 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattermapbox.marker.co - lorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scattermapbox.m + arker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -1392,8 +1392,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattermapbox.marker.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.marker.color + bar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scattermapbox.marker.colorbar.title.font instead. Sets @@ -1489,8 +1489,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.marker.ColorBar + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -1603,8 +1603,8 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattermapbox.marker.co - lorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scattermapbox.m + arker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -1645,8 +1645,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattermapbox.marker.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.marker.color + bar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scattermapbox.marker.colorbar.title.font instead. Sets @@ -1700,7 +1700,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattermapbox.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scattermapbox.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py index 51051c21e83..d7a6d377a43 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.marker.c - olorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.marker.c - olorbar.Tickfont + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py index c2fe404004e..ec3f32e6e4b 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.marker.c - olorbar.title.Font + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/__init__.py index 212af46ea92..e10667bcbc6 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/__init__.py @@ -130,8 +130,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.selected.Marker + an instance of :class:`plotly.graph_objs.scattermapbox. + selected.Marker` color Sets the marker color of selected points. opacity @@ -158,7 +158,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.selected.Marker""" +an instance of :class:`plotly.graph_objs.scattermapbox.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/__init__.py index 33fef1bb849..b1b5488f9f1 100644 --- a/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/__init__.py @@ -136,8 +136,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.unselected.Marker + an instance of :class:`plotly.graph_objs.scattermapbox. + unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -167,7 +167,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scattermapbox.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scattermapbox.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/__init__.py index 4be815f7103..4ccf7ff8645 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.unselected.Marker + - An instance of :class:`plotly.graph_objs.scatterpolar.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scatterpolar.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatterpolar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.unselected.Ma + rker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolar.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.unselected.Te + xtfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -92,13 +92,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.Unselected + :class:`plotly.graph_objs.scatterpolar.Unselected` marker - plotly.graph_objects.scatterpolar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.unselected.Ma + rker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolar.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.unselected.Te + xtfont` instance or dict with compatible properties Returns ------- @@ -119,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Unselected""" +an instance of :class:`plotly.graph_objs.scatterpolar.Unselected`""" ) # Handle skip_invalid @@ -383,7 +383,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Textfont + an instance of + :class:`plotly.graph_objs.scatterpolar.Textfont` color colorsrc @@ -428,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Textfont""" +an instance of :class:`plotly.graph_objs.scatterpolar.Textfont`""" ) # Handle skip_invalid @@ -551,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Stream + an instance of + :class:`plotly.graph_objs.scatterpolar.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -581,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.Stream constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Stream""" +an instance of :class:`plotly.graph_objs.scatterpolar.Stream`""" ) # Handle skip_invalid @@ -626,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.selected.Marker + - An instance of :class:`plotly.graph_objs.scatterpolar.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -656,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.selected.Textfont + - An instance of :class:`plotly.graph_objs.scatterpolar.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -687,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatterpolar.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.selected.Mark + er` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolar.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.selected.Text + font` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -702,13 +704,14 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Selected + an instance of + :class:`plotly.graph_objs.scatterpolar.Selected` marker - plotly.graph_objects.scatterpolar.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.selected.Mark + er` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolar.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.selected.Text + font` instance or dict with compatible properties Returns ------- @@ -729,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.Selected constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Selected""" +an instance of :class:`plotly.graph_objs.scatterpolar.Selected`""" ) # Handle skip_invalid @@ -987,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1119,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolar.ma - rker.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + polar.marker.colorbar.Tickformatstop` instances + or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatterpolar.marker.colorbar.tickformatstopde @@ -1168,9 +1171,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolar.marker.colorb - ar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolar.marke + r.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scatterpolar.marker.colorbar.title.font @@ -1296,7 +1299,7 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.Gradient + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.Gradient` - A dict of string/value properties that will be passed to the Gradient constructor @@ -1333,7 +1336,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.Line + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1816,8 +1819,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolar.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.ColorB + ar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1835,11 +1838,11 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterpolar.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.Gradie + nt` instance or dict with compatible properties line - plotly.graph_objects.scatterpolar.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.Line` + instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -1920,7 +1923,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Marker + an instance of + :class:`plotly.graph_objs.scatterpolar.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1968,8 +1972,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolar.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.ColorB + ar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1987,11 +1991,11 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterpolar.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.Gradie + nt` instance or dict with compatible properties line - plotly.graph_objects.scatterpolar.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.Line` + instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -2054,7 +2058,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Marker""" +an instance of :class:`plotly.graph_objs.scatterpolar.Marker`""" ) # Handle skip_invalid @@ -2355,7 +2359,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Line + an instance of + :class:`plotly.graph_objs.scatterpolar.Line` color Sets the line color. dash @@ -2393,7 +2398,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.Line constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Line""" +an instance of :class:`plotly.graph_objs.scatterpolar.Line`""" ) # Handle skip_invalid @@ -2653,7 +2658,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scatterpolar.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2809,7 +2814,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.Hoverlabel + :class:`plotly.graph_objs.scatterpolar.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2858,7 +2863,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py index 6918652859d..71ea7921f69 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.hoverlabel.Font + :class:`plotly.graph_objs.scatterpolar.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scatterpolar.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/__init__.py index 33e41b44f23..dd97bcd9c46 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/__init__.py @@ -472,7 +472,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.marker.Line + :class:`plotly.graph_objs.scatterpolar.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -570,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.Line""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.Line`""" ) # Handle skip_invalid @@ -795,7 +795,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.marker.Gradient + :class:`plotly.graph_objs.scatterpolar.marker.Gradient` color Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the @@ -826,7 +826,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.marker.Gradient constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.Gradient""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.Gradient`""" ) # Handle skip_invalid @@ -1491,7 +1491,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1625,7 +1625,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1863,7 +1863,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1907,7 +1907,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2216,9 +2216,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolar.marker.col - orbar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatterpolar.ma + rker.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte rpolar.marker.colorbar.tickformatstopdefaults), sets @@ -2258,8 +2258,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolar.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.colorb + ar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scatterpolar.marker.colorbar.title.font instead. Sets @@ -2356,7 +2356,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.marker.ColorBar + :class:`plotly.graph_objs.scatterpolar.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2469,9 +2469,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolar.marker.col - orbar.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.scatterpolar.ma + rker.colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte rpolar.marker.colorbar.tickformatstopdefaults), sets @@ -2511,8 +2511,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolar.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marker.colorb + ar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scatterpolar.marker.colorbar.title.font instead. Sets @@ -2566,7 +2566,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py index dfb019c3293..263725c22ce 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.marker.co - lorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py index 0d8d6da32a0..6e7e79e090a 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.marker.co - lorbar.title.Font + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/__init__.py index a3572767a2b..c7318d84a16 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/__init__.py @@ -86,8 +86,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.selected.Textfont + an instance of :class:`plotly.graph_objs.scatterpolar.s + elected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scatterpolar.selected.Textfont`""" ) # Handle skip_invalid @@ -272,7 +272,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolar.selected.Marker + :class:`plotly.graph_objs.scatterpolar.selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.selected.Marker""" +an instance of :class:`plotly.graph_objs.scatterpolar.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/__init__.py index 579f1a5be12..67b17c7513c 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.unselected.Textfont + an instance of :class:`plotly.graph_objs.scatterpolar.u + nselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scatterpolar.unselected.Textfont`""" ) # Handle skip_invalid @@ -280,8 +280,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.unselected.Marker + an instance of :class:`plotly.graph_objs.scatterpolar.u + nselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolar.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scatterpolar.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/__init__.py index bda59de7062..b5d8ed82d86 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.unselected.Marker + - An instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatterpolargl.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.unselected. + Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolargl.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.unselected. + Textfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -92,13 +92,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolargl.Unselected + :class:`plotly.graph_objs.scatterpolargl.Unselected` marker - plotly.graph_objects.scatterpolargl.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.unselected. + Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolargl.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.unselected. + Textfont` instance or dict with compatible properties Returns ------- @@ -119,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Unselected""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Unselected`""" ) # Handle skip_invalid @@ -384,7 +384,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolargl.Textfont + :class:`plotly.graph_objs.scatterpolargl.Textfont` color colorsrc @@ -429,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Textfont""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Textfont`""" ) # Handle skip_invalid @@ -552,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.Stream + an instance of + :class:`plotly.graph_objs.scatterpolargl.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -582,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.Stream constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Stream""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Stream`""" ) # Handle skip_invalid @@ -627,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.selected.Marker + - An instance of :class:`plotly.graph_objs.scatterpolargl.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -657,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.selected.Textfont + - An instance of :class:`plotly.graph_objs.scatterpolargl.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -688,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatterpolargl.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.selected.Ma + rker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolargl.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.selected.Te + xtfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -704,13 +705,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolargl.Selected + :class:`plotly.graph_objs.scatterpolargl.Selected` marker - plotly.graph_objects.scatterpolargl.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.selected.Ma + rker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolargl.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.selected.Te + xtfont` instance or dict with compatible properties Returns ------- @@ -731,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.Selected constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Selected""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Selected`""" ) # Handle skip_invalid @@ -989,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1121,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolargl. - marker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + polargl.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatterpolargl.marker.colorbar.tickformatstop @@ -1170,9 +1171,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolargl.marker.colo - rbar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.mar + ker.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scatterpolargl.marker.colorbar.title.font @@ -1298,7 +1299,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.Line + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1760,8 +1761,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolargl.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.marker.Colo + rBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1779,8 +1780,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatterpolargl.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.marker.Line + ` instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1856,7 +1857,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.Marker + an instance of + :class:`plotly.graph_objs.scatterpolargl.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1904,8 +1906,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolargl.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.marker.Colo + rBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1923,8 +1925,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatterpolargl.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.marker.Line + ` instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1984,7 +1986,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Marker""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Marker`""" ) # Handle skip_invalid @@ -2237,7 +2239,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.Line + an instance of + :class:`plotly.graph_objs.scatterpolargl.Line` color Sets the line color. dash @@ -2267,7 +2270,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.Line constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Line""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Line`""" ) # Handle skip_invalid @@ -2524,7 +2527,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scatterpolargl.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2680,7 +2683,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolargl.Hoverlabel + :class:`plotly.graph_objs.scatterpolargl.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2729,7 +2732,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py index 75d918e0fb7..4ab5c9ee9c9 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.hoverlabel.Font + an instance of :class:`plotly.graph_objs.scatterpolargl + .hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scatterpolargl.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/__init__.py index 81ba00afda0..b324b6918a9 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/__init__.py @@ -472,7 +472,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterpolargl.marker.Line + :class:`plotly.graph_objs.scatterpolargl.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -570,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.Line""" +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.Line`""" ) # Handle skip_invalid @@ -1259,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1393,7 +1393,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1631,7 +1631,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1675,7 +1675,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1985,8 +1985,8 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolargl.marker.c - olorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scatterpolargl. + marker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -2027,8 +2027,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolargl.marker.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.marker.colo + rbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scatterpolargl.marker.colorbar.title.font instead. Sets @@ -2124,8 +2124,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.marker.ColorBar + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2238,8 +2238,8 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolargl.marker.c - olorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scatterpolargl. + marker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -2280,8 +2280,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolargl.marker.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.marker.colo + rbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scatterpolargl.marker.colorbar.title.font instead. Sets @@ -2335,7 +2335,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py index f4f778f5e03..54b6721a393 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.marker. - colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.marker. - colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py index 00be4f4c361..c1e53cc6b4e 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.marker. - colorbar.title.Font + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/__init__.py index c70d25702c5..1e774cac3ba 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/__init__.py @@ -86,8 +86,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.selected.Textfont + an instance of :class:`plotly.graph_objs.scatterpolargl + .selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scatterpolargl.selected.Textfont`""" ) # Handle skip_invalid @@ -271,8 +271,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.selected.Marker + an instance of :class:`plotly.graph_objs.scatterpolargl + .selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.selected.Marker""" +an instance of :class:`plotly.graph_objs.scatterpolargl.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/__init__.py index 9f045e643dc..fd7cd672cb2 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.unselected.Textfont + an instance of :class:`plotly.graph_objs.scatterpolargl + .unselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Textfont`""" ) # Handle skip_invalid @@ -280,8 +280,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.unselected.Marker + an instance of :class:`plotly.graph_objs.scatterpolargl + .unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterpolargl.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/__init__.py index 422f97741ff..08472a0112f 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterternary.unselected.Marker + - An instance of :class:`plotly.graph_objs.scatterternary.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -44,7 +44,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterternary.unselected.Textfont + - An instance of :class:`plotly.graph_objs.scatterternary.unselected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -76,11 +76,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatterternary.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.unselected. + Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterternary.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.unselected. + Textfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -92,13 +92,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterternary.Unselected + :class:`plotly.graph_objs.scatterternary.Unselected` marker - plotly.graph_objects.scatterternary.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.unselected. + Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterternary.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.unselected. + Textfont` instance or dict with compatible properties Returns ------- @@ -119,7 +119,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.Unselected constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Unselected""" +an instance of :class:`plotly.graph_objs.scatterternary.Unselected`""" ) # Handle skip_invalid @@ -384,7 +384,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterternary.Textfont + :class:`plotly.graph_objs.scatterternary.Textfont` color colorsrc @@ -429,7 +429,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Textfont""" +an instance of :class:`plotly.graph_objs.scatterternary.Textfont`""" ) # Handle skip_invalid @@ -552,7 +552,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.Stream + an instance of + :class:`plotly.graph_objs.scatterternary.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -582,7 +583,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.Stream constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Stream""" +an instance of :class:`plotly.graph_objs.scatterternary.Stream`""" ) # Handle skip_invalid @@ -627,7 +628,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.scatterternary.selected.Marker + - An instance of :class:`plotly.graph_objs.scatterternary.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -657,7 +658,7 @@ def textfont(self): """ The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.scatterternary.selected.Textfont + - An instance of :class:`plotly.graph_objs.scatterternary.selected.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -688,11 +689,11 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.scatterternary.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.selected.Ma + rker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterternary.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.selected.Te + xtfont` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): @@ -704,13 +705,13 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterternary.Selected + :class:`plotly.graph_objs.scatterternary.Selected` marker - plotly.graph_objects.scatterternary.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.selected.Ma + rker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterternary.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.selected.Te + xtfont` instance or dict with compatible properties Returns ------- @@ -731,7 +732,7 @@ def __init__(self, arg=None, marker=None, textfont=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.Selected constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Selected""" +an instance of :class:`plotly.graph_objs.scatterternary.Selected`""" ) # Handle skip_invalid @@ -989,7 +990,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.ColorBar + - An instance of :class:`plotly.graph_objs.scatterternary.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1121,9 +1122,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterternary. - marker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + ternary.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatterternary.marker.colorbar.tickformatstop @@ -1170,9 +1171,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterternary.marker.colo - rbar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.mar + ker.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scatterternary.marker.colorbar.title.font @@ -1298,7 +1299,7 @@ def gradient(self): """ The 'gradient' property is an instance of Gradient that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.Gradient + - An instance of :class:`plotly.graph_objs.scatterternary.marker.Gradient` - A dict of string/value properties that will be passed to the Gradient constructor @@ -1335,7 +1336,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.Line + - An instance of :class:`plotly.graph_objs.scatterternary.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1818,8 +1819,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterternary.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.Colo + rBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1837,11 +1838,11 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterternary.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.Grad + ient` instance or dict with compatible properties line - plotly.graph_objects.scatterternary.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.Line + ` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -1922,7 +1923,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.Marker + an instance of + :class:`plotly.graph_objs.scatterternary.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1970,8 +1972,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterternary.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.Colo + rBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1989,11 +1991,11 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterternary.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.Grad + ient` instance or dict with compatible properties line - plotly.graph_objects.scatterternary.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.Line + ` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. @@ -2056,7 +2058,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Marker""" +an instance of :class:`plotly.graph_objs.scatterternary.Marker`""" ) # Handle skip_invalid @@ -2357,7 +2359,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.Line + an instance of + :class:`plotly.graph_objs.scatterternary.Line` color Sets the line color. dash @@ -2395,7 +2398,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.Line constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Line""" +an instance of :class:`plotly.graph_objs.scatterternary.Line`""" ) # Handle skip_invalid @@ -2655,7 +2658,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterternary.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.scatterternary.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2811,7 +2814,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterternary.Hoverlabel + :class:`plotly.graph_objs.scatterternary.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2860,7 +2863,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Hoverlabel""" +an instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/__init__.py index fb6bba59074..b254019286c 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/__init__.py @@ -230,8 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.hoverlabel.Font + an instance of :class:`plotly.graph_objs.scatterternary + .hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.scatterternary.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/__init__.py index 9063d068766..2de815c61ff 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/__init__.py @@ -472,7 +472,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.scatterternary.marker.Line + :class:`plotly.graph_objs.scatterternary.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -570,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.Line""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.Line`""" ) # Handle skip_invalid @@ -794,8 +794,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.Gradient + an instance of :class:`plotly.graph_objs.scatterternary + .marker.Gradient` color Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the @@ -826,7 +826,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.marker.Gradient constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.Gradient""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.Gradient`""" ) # Handle skip_invalid @@ -1491,7 +1491,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1625,7 +1625,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1863,7 +1863,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1907,7 +1907,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2217,8 +2217,8 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterternary.marker.c - olorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scatterternary. + marker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -2259,8 +2259,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterternary.marker.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.colo + rbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scatterternary.marker.colorbar.title.font instead. Sets @@ -2356,8 +2356,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.ColorBar + an instance of :class:`plotly.graph_objs.scatterternary + .marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2470,8 +2470,8 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterternary.marker.c - olorbar.Tickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.scatterternary. + marker.colorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.data.scatte @@ -2512,8 +2512,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterternary.marker.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.marker.colo + rbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use scatterternary.marker.colorbar.title.font instead. Sets @@ -2567,7 +2567,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py index 0ac3e027af1..c38f2f2daf0 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.scatterternary.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.marker. - colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.marker. - colorbar.Tickfont + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py index b9437a37fd6..21f2fd888b9 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.marker. - colorbar.title.Font + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/selected/__init__.py index ce8b549087c..a594966057a 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/selected/__init__.py @@ -86,8 +86,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.selected.Textfont + an instance of :class:`plotly.graph_objs.scatterternary + .selected.Textfont` color Sets the text font color of selected points. @@ -110,7 +110,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.selected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.selected.Textfont""" +an instance of :class:`plotly.graph_objs.scatterternary.selected.Textfont`""" ) # Handle skip_invalid @@ -271,8 +271,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.selected.Marker + an instance of :class:`plotly.graph_objs.scatterternary + .selected.Marker` color Sets the marker color of selected points. opacity @@ -299,7 +299,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.selected.Marker""" +an instance of :class:`plotly.graph_objs.scatterternary.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/__init__.py index bfad50c965a..6457e1ca2d9 100644 --- a/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/__init__.py @@ -88,8 +88,8 @@ def __init__(self, arg=None, color=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.unselected.Textfont + an instance of :class:`plotly.graph_objs.scatterternary + .unselected.Textfont` color Sets the text font color of unselected points, applied only when a selection exists. @@ -113,7 +113,7 @@ def __init__(self, arg=None, color=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.unselected.Textfont constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.unselected.Textfont""" +an instance of :class:`plotly.graph_objs.scatterternary.unselected.Textfont`""" ) # Handle skip_invalid @@ -280,8 +280,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.unselected.Marker + an instance of :class:`plotly.graph_objs.scatterternary + .unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -311,7 +311,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.scatterternary.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.unselected.Marker""" +an instance of :class:`plotly.graph_objs.scatterternary.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/__init__.py index 099ff601676..1036f5db933 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.splom.unselected.Marker + - An instance of :class:`plotly.graph_objs.splom.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -49,8 +49,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.splom.unselected.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.splom.unselected.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -61,10 +61,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Unselected + an instance of + :class:`plotly.graph_objs.splom.Unselected` marker - plotly.graph_objects.splom.unselected.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.splom.unselected.Marker` + instance or dict with compatible properties Returns ------- @@ -85,7 +86,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.Unselected constructor must be a dict or -an instance of plotly.graph_objs.splom.Unselected""" +an instance of :class:`plotly.graph_objs.splom.Unselected`""" ) # Handle skip_invalid @@ -193,7 +194,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Stream + an instance of :class:`plotly.graph_objs.splom.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -223,7 +224,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.Stream constructor must be a dict or -an instance of plotly.graph_objs.splom.Stream""" +an instance of :class:`plotly.graph_objs.splom.Stream`""" ) # Handle skip_invalid @@ -268,7 +269,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.splom.selected.Marker + - An instance of :class:`plotly.graph_objs.splom.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -303,8 +304,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.splom.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.selected.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -315,10 +316,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Selected + an instance of + :class:`plotly.graph_objs.splom.Selected` marker - plotly.graph_objects.splom.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.selected.Marker` + instance or dict with compatible properties Returns ------- @@ -339,7 +341,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.Selected constructor must be a dict or -an instance of plotly.graph_objs.splom.Selected""" +an instance of :class:`plotly.graph_objs.splom.Selected`""" ) # Handle skip_invalid @@ -594,7 +596,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.splom.marker.ColorBar + - An instance of :class:`plotly.graph_objs.splom.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -726,9 +728,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.splom.marker.co - lorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.splom.m + arker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.splom.marker.colorbar.tickformatstopdefaults) @@ -775,8 +777,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.splom.marker.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.color + bar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use splom.marker.colorbar.title.font instead. Sets @@ -902,7 +905,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.splom.marker.Line + - An instance of :class:`plotly.graph_objs.splom.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1364,8 +1367,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.splom.marker.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1383,8 +1386,8 @@ def _prop_descriptions(self): colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.splom.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1460,7 +1463,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Marker + an instance of :class:`plotly.graph_objs.splom.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1508,8 +1511,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.splom.marker.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.marker.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -1527,8 +1530,8 @@ def __init__( colorsrc Sets the source reference on plot.ly for color . line - plotly.graph_objects.splom.marker.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.splom.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -1588,7 +1591,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.Marker constructor must be a dict or -an instance of plotly.graph_objs.splom.Marker""" +an instance of :class:`plotly.graph_objs.splom.Marker`""" ) # Handle skip_invalid @@ -1899,7 +1902,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.splom.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.splom.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2054,7 +2057,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Hoverlabel + an instance of + :class:`plotly.graph_objs.splom.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2103,7 +2107,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.splom.Hoverlabel""" +an instance of :class:`plotly.graph_objs.splom.Hoverlabel`""" ) # Handle skip_invalid @@ -2169,7 +2173,7 @@ def axis(self): """ The 'axis' property is an instance of Axis that may be specified as: - - An instance of plotly.graph_objs.splom.dimension.Axis + - An instance of :class:`plotly.graph_objs.splom.dimension.Axis` - A dict of string/value properties that will be passed to the Axis constructor @@ -2346,8 +2350,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ axis - plotly.graph_objects.splom.dimension.Axis instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.dimension.Axis` + instance or dict with compatible properties label Sets the label corresponding to this splom dimension. name @@ -2399,10 +2403,11 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Dimension + an instance of + :class:`plotly.graph_objs.splom.Dimension` axis - plotly.graph_objects.splom.dimension.Axis instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.dimension.Axis` + instance or dict with compatible properties label Sets the label corresponding to this splom dimension. name @@ -2453,7 +2458,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.Dimension constructor must be a dict or -an instance of plotly.graph_objs.splom.Dimension""" +an instance of :class:`plotly.graph_objs.splom.Dimension`""" ) # Handle skip_invalid @@ -2553,7 +2558,8 @@ def __init__(self, arg=None, visible=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Diagonal + an instance of + :class:`plotly.graph_objs.splom.Diagonal` visible Determines whether or not subplots on the diagonal are displayed. @@ -2577,7 +2583,7 @@ def __init__(self, arg=None, visible=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.Diagonal constructor must be a dict or -an instance of plotly.graph_objs.splom.Diagonal""" +an instance of :class:`plotly.graph_objs.splom.Diagonal`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/dimension/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/dimension/__init__.py index 9e11894a3f3..a3ba38a226e 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/dimension/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/dimension/__init__.py @@ -79,7 +79,8 @@ def __init__(self, arg=None, matches=None, type=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.dimension.Axis + an instance of + :class:`plotly.graph_objs.splom.dimension.Axis` matches Determines whether or not the x & y axes generated by this dimension match. Equivalent to setting the @@ -109,7 +110,7 @@ def __init__(self, arg=None, matches=None, type=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.dimension.Axis constructor must be a dict or -an instance of plotly.graph_objs.splom.dimension.Axis""" +an instance of :class:`plotly.graph_objs.splom.dimension.Axis`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/__init__.py index da827130790..cbe9b033f68 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.splom.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.splom.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.splom.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/marker/__init__.py index db78da6c5ab..05553612f88 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/marker/__init__.py @@ -471,7 +471,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.marker.Line + an instance of + :class:`plotly.graph_objs.splom.marker.Line` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -569,7 +570,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.Line""" +an instance of :class:`plotly.graph_objs.splom.marker.Line`""" ) # Handle skip_invalid @@ -1258,7 +1259,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.splom.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1392,7 +1393,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.splom.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1630,7 +1631,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.splom.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1674,7 +1675,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.splom.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1983,9 +1984,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.splom.marker.colorbar.T - ickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.splom.marker.co + lorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.splom. marker.colorbar.tickformatstopdefaults), sets the @@ -2025,8 +2026,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.splom.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.colorbar.Titl + e` instance or dict with compatible properties titlefont Deprecated: Please use splom.marker.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2120,7 +2121,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.marker.ColorBar + an instance of + :class:`plotly.graph_objs.splom.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2233,9 +2235,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.splom.marker.colorbar.T - ickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.splom.marker.co + lorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.splom. marker.colorbar.tickformatstopdefaults), sets the @@ -2275,8 +2277,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.splom.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.colorbar.Titl + e` instance or dict with compatible properties titlefont Deprecated: Please use splom.marker.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2328,7 +2330,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.splom.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/__init__.py index 75b069d730b..e6df0b1719b 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.splom.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.splom.marker.colorbar.Title + :class:`plotly.graph_objs.splom.marker.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.splom.marker.c + olorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.splom.marker.c + olorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/__init__.py index cf1ef031f25..c9d86c0c96a 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.splom.marker.c + olorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/selected/__init__.py index d7360e00a32..29135de23c4 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/selected/__init__.py @@ -130,7 +130,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.selected.Marker + an instance of + :class:`plotly.graph_objs.splom.selected.Marker` color Sets the marker color of selected points. opacity @@ -157,7 +158,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.splom.selected.Marker""" +an instance of :class:`plotly.graph_objs.splom.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/splom/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/splom/unselected/__init__.py index 3ea1f1a8379..42f5efaff97 100644 --- a/packages/python/plotly/plotly/graph_objs/splom/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/splom/unselected/__init__.py @@ -137,7 +137,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.splom.unselected.Marker + :class:`plotly.graph_objs.splom.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -167,7 +167,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.splom.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.splom.unselected.Marker""" +an instance of :class:`plotly.graph_objs.splom.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/__init__.py b/packages/python/plotly/plotly/graph_objs/streamtube/__init__.py index 41bd83d35c4..0678122fe76 100644 --- a/packages/python/plotly/plotly/graph_objs/streamtube/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/streamtube/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Stream + an instance of + :class:`plotly.graph_objs.streamtube.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.streamtube.Stream constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Stream""" +an instance of :class:`plotly.graph_objs.streamtube.Stream`""" ) # Handle skip_invalid @@ -314,7 +315,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Starts + an instance of + :class:`plotly.graph_objs.streamtube.Starts` x Sets the x components of the starting position of the streamtubes @@ -350,7 +352,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.streamtube.Starts constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Starts""" +an instance of :class:`plotly.graph_objs.streamtube.Starts`""" ) # Handle skip_invalid @@ -491,7 +493,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.streamtube.Lightposition + :class:`plotly.graph_objs.streamtube.Lightposition` x Numeric vector, representing the X coordinate for each vertex. @@ -521,7 +523,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.streamtube.Lightposition constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Lightposition""" +an instance of :class:`plotly.graph_objs.streamtube.Lightposition`""" ) # Handle skip_invalid @@ -765,7 +767,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Lighting + an instance of + :class:`plotly.graph_objs.streamtube.Lighting` ambient Ambient light increases overall color visibility but can wash out the image. @@ -809,7 +812,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.streamtube.Lighting constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Lighting""" +an instance of :class:`plotly.graph_objs.streamtube.Lighting`""" ) # Handle skip_invalid @@ -1083,7 +1086,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.streamtube.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.streamtube.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1238,7 +1241,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Hoverlabel + an instance of + :class:`plotly.graph_objs.streamtube.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1287,7 +1291,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.streamtube.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Hoverlabel""" +an instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`""" ) # Handle skip_invalid @@ -1967,7 +1971,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.streamtube.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2100,7 +2104,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.streamtube.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2338,7 +2342,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.streamtube.colorbar.Title + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2381,7 +2385,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.streamtube.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2690,9 +2694,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.streamtube.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.streamtube.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.stream tube.colorbar.tickformatstopdefaults), sets the default @@ -2732,8 +2736,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.streamtube.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use streamtube.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2827,7 +2831,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.ColorBar + an instance of + :class:`plotly.graph_objs.streamtube.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2940,9 +2945,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.streamtube.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.streamtube.colo + rbar.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.stream tube.colorbar.tickformatstopdefaults), sets the default @@ -2982,8 +2987,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.streamtube.colorbar.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use streamtube.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -3035,7 +3040,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.streamtube.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.streamtube.ColorBar""" +an instance of :class:`plotly.graph_objs.streamtube.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/__init__.py index ca36426ea6e..187052e1985 100644 --- a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.streamtube.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -132,7 +132,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.streamtube.colorbar.Title + :class:`plotly.graph_objs.streamtube.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.streamtube.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.Title""" +an instance of :class:`plotly.graph_objs.streamtube.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.streamtube.col + orbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.streamtube.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -644,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.streamtube.colorbar.Tickfont + :class:`plotly.graph_objs.streamtube.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.streamtube.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/__init__.py index 14bc9576bfa..40af14188ce 100644 --- a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.colorbar.title.Font + an instance of :class:`plotly.graph_objs.streamtube.col + orbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.streamtube.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.streamtube.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/__init__.py index c649fc2865b..797db295ea9 100644 --- a/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.streamtube.hoverlabel.Font + :class:`plotly.graph_objs.streamtube.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.streamtube.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.streamtube.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.streamtube.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/__init__.py b/packages/python/plotly/plotly/graph_objs/sunburst/__init__.py index 55d695b6c65..2cf8c46edbb 100644 --- a/packages/python/plotly/plotly/graph_objs/sunburst/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sunburst/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.Textfont + an instance of + :class:`plotly.graph_objs.sunburst.Textfont` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.Textfont constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Textfont""" +an instance of :class:`plotly.graph_objs.sunburst.Textfont`""" ) # Handle skip_invalid @@ -398,7 +399,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.Stream + an instance of + :class:`plotly.graph_objs.sunburst.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -428,7 +430,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.sunburst.Stream constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Stream""" +an instance of :class:`plotly.graph_objs.sunburst.Stream`""" ) # Handle skip_invalid @@ -697,7 +699,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.sunburst.Outsidetextfont + :class:`plotly.graph_objs.sunburst.Outsidetextfont` color colorsrc @@ -742,7 +744,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.Outsidetextfont constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Outsidetextfont""" +an instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont`""" ) # Handle skip_invalid @@ -944,7 +946,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.ColorBar + - An instance of :class:`plotly.graph_objs.sunburst.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1076,9 +1078,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.sunburst.marker - .colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.sunburs + t.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.sunburst.marker.colorbar.tickformatstopdefaul @@ -1125,8 +1127,8 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.sunburst.marker.colorbar.T - itle instance or dict with compatible + :class:`plotly.graph_objects.sunburst.marker.co + lorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use @@ -1274,7 +1276,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.Line + - An instance of :class:`plotly.graph_objs.sunburst.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1398,8 +1400,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.sunburst.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.ColorBar` + instance or dict with compatible properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick @@ -1421,8 +1423,8 @@ def _prop_descriptions(self): colorssrc Sets the source reference on plot.ly for colors . line - plotly.graph_objects.sunburst.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.Line` + instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical array. If true, @@ -1460,7 +1462,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.Marker + an instance of + :class:`plotly.graph_objs.sunburst.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -1501,8 +1504,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.sunburst.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.ColorBar` + instance or dict with compatible properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick @@ -1524,8 +1527,8 @@ def __init__( colorssrc Sets the source reference on plot.ly for colors . line - plotly.graph_objects.sunburst.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.Line` + instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical array. If true, @@ -1556,7 +1559,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.Marker constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Marker""" +an instance of :class:`plotly.graph_objs.sunburst.Marker`""" ) # Handle skip_invalid @@ -1672,7 +1675,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.Leaf + an instance of :class:`plotly.graph_objs.sunburst.Leaf` opacity Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7 @@ -1696,7 +1699,7 @@ def __init__(self, arg=None, opacity=None, **kwargs): """\ The first argument to the plotly.graph_objs.sunburst.Leaf constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Leaf""" +an instance of :class:`plotly.graph_objs.sunburst.Leaf`""" ) # Handle skip_invalid @@ -1958,7 +1961,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.sunburst.Insidetextfont + :class:`plotly.graph_objs.sunburst.Insidetextfont` color colorsrc @@ -2003,7 +2006,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Insidetextfont""" +an instance of :class:`plotly.graph_objs.sunburst.Insidetextfont`""" ) # Handle skip_invalid @@ -2266,7 +2269,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.sunburst.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.sunburst.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2421,7 +2424,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.Hoverlabel + an instance of + :class:`plotly.graph_objs.sunburst.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2470,7 +2474,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Hoverlabel""" +an instance of :class:`plotly.graph_objs.sunburst.Hoverlabel`""" ) # Handle skip_invalid @@ -2658,7 +2662,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.Domain + an instance of + :class:`plotly.graph_objs.sunburst.Domain` column If there is a layout grid, use the domain for this column in the grid for this sunburst trace . @@ -2691,7 +2696,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.sunburst.Domain constructor must be a dict or -an instance of plotly.graph_objs.sunburst.Domain""" +an instance of :class:`plotly.graph_objs.sunburst.Domain`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/__init__.py index ddc8eb20fcb..708b655f673 100644 --- a/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.sunburst.hoverlabel.Font + :class:`plotly.graph_objs.sunburst.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.sunburst.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.sunburst.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/__init__.py index 43d935ed292..6b5beef02d9 100644 --- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/__init__.py @@ -159,7 +159,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.marker.Line + an instance of + :class:`plotly.graph_objs.sunburst.marker.Line` color Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value. @@ -190,7 +191,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.sunburst.marker.Line""" +an instance of :class:`plotly.graph_objs.sunburst.marker.Line`""" ) # Handle skip_invalid @@ -855,7 +856,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -989,7 +990,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1227,7 +1228,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1271,7 +1272,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1580,9 +1581,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.sunburst.marker.colorba - r.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.sunburst.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.sunbur st.marker.colorbar.tickformatstopdefaults), sets the @@ -1622,8 +1623,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.sunburst.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.colorbar.T + itle` instance or dict with compatible properties titlefont Deprecated: Please use sunburst.marker.colorbar.title.font instead. Sets this @@ -1718,7 +1719,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.sunburst.marker.ColorBar + :class:`plotly.graph_objs.sunburst.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -1831,9 +1832,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.sunburst.marker.colorba - r.Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.sunburst.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.sunbur st.marker.colorbar.tickformatstopdefaults), sets the @@ -1873,8 +1874,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.sunburst.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.colorbar.T + itle` instance or dict with compatible properties titlefont Deprecated: Please use sunburst.marker.colorbar.title.font instead. Sets this @@ -1926,7 +1927,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.sunburst.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.sunburst.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/__init__.py index d5276677c69..f8bf621d2cc 100644 --- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.sunburst.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.sunburst.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.sunburst.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.sunburst.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sunburst.marker.colorb - ar.Tickformatstop + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.sunburst.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.sunburst.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.sunburst.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py index 3a569ad5706..603e412b012 100644 --- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.sunburst.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.sunburst.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.sunburst.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/__init__.py index 7c94451bb29..6a7997e9a19 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/__init__.py @@ -77,7 +77,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Stream + an instance of + :class:`plotly.graph_objs.surface.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +108,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.Stream constructor must be a dict or -an instance of plotly.graph_objs.surface.Stream""" +an instance of :class:`plotly.graph_objs.surface.Stream`""" ) # Handle skip_invalid @@ -235,7 +236,8 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Lightposition + an instance of + :class:`plotly.graph_objs.surface.Lightposition` x Numeric vector, representing the X coordinate for each vertex. @@ -265,7 +267,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.Lightposition constructor must be a dict or -an instance of plotly.graph_objs.surface.Lightposition""" +an instance of :class:`plotly.graph_objs.surface.Lightposition`""" ) # Handle skip_invalid @@ -459,7 +461,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Lighting + an instance of + :class:`plotly.graph_objs.surface.Lighting` ambient Ambient light increases overall color visibility but can wash out the image. @@ -497,7 +500,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.Lighting constructor must be a dict or -an instance of plotly.graph_objs.surface.Lighting""" +an instance of :class:`plotly.graph_objs.surface.Lighting`""" ) # Handle skip_invalid @@ -757,7 +760,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.surface.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.surface.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -912,7 +915,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Hoverlabel + an instance of + :class:`plotly.graph_objs.surface.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -961,7 +965,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.surface.Hoverlabel""" +an instance of :class:`plotly.graph_objs.surface.Hoverlabel`""" ) # Handle skip_invalid @@ -1027,7 +1031,7 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of plotly.graph_objs.surface.contours.X + - An instance of :class:`plotly.graph_objs.surface.contours.X` - A dict of string/value properties that will be passed to the X constructor @@ -1048,8 +1052,9 @@ def x(self): Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.x.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.x + .Project` instance or dict with compatible + properties show Determines whether or not contour lines about the x dimension are drawn. @@ -1083,7 +1088,7 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of plotly.graph_objs.surface.contours.Y + - An instance of :class:`plotly.graph_objs.surface.contours.Y` - A dict of string/value properties that will be passed to the Y constructor @@ -1104,8 +1109,9 @@ def y(self): Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.y.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.y + .Project` instance or dict with compatible + properties show Determines whether or not contour lines about the y dimension are drawn. @@ -1139,7 +1145,7 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of plotly.graph_objs.surface.contours.Z + - An instance of :class:`plotly.graph_objs.surface.contours.Z` - A dict of string/value properties that will be passed to the Z constructor @@ -1160,8 +1166,9 @@ def z(self): Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.z.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.z + .Project` instance or dict with compatible + properties show Determines whether or not contour lines about the z dimension are drawn. @@ -1200,14 +1207,14 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ x - plotly.graph_objects.surface.contours.X instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.contours.X` + instance or dict with compatible properties y - plotly.graph_objects.surface.contours.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Y` + instance or dict with compatible properties z - plotly.graph_objects.surface.contours.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Z` + instance or dict with compatible properties """ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): @@ -1218,16 +1225,17 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Contours + an instance of + :class:`plotly.graph_objs.surface.Contours` x - plotly.graph_objects.surface.contours.X instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.contours.X` + instance or dict with compatible properties y - plotly.graph_objects.surface.contours.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Y` + instance or dict with compatible properties z - plotly.graph_objects.surface.contours.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Z` + instance or dict with compatible properties Returns ------- @@ -1248,7 +1256,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.Contours constructor must be a dict or -an instance of plotly.graph_objs.surface.Contours""" +an instance of :class:`plotly.graph_objs.surface.Contours`""" ) # Handle skip_invalid @@ -1910,7 +1918,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.surface.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.surface.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2044,7 +2052,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.surface.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.surface.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2282,7 +2290,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.surface.colorbar.Title + - An instance of :class:`plotly.graph_objs.surface.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2325,7 +2333,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.surface.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.surface.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2634,9 +2642,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.surface.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.surface.colorba + r.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.surfac e.colorbar.tickformatstopdefaults), sets the default @@ -2676,8 +2684,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.surface.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use surface.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2771,7 +2779,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.ColorBar + an instance of + :class:`plotly.graph_objs.surface.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2884,9 +2893,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.surface.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.surface.colorba + r.Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.surfac e.colorbar.tickformatstopdefaults), sets the default @@ -2926,8 +2935,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.surface.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use surface.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -2979,7 +2988,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.surface.ColorBar""" +an instance of :class:`plotly.graph_objs.surface.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/colorbar/__init__.py index afdfa2b45da..4e2e91fe412 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.surface.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.surface.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,7 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.colorbar.Title + an instance of + :class:`plotly.graph_objs.surface.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -166,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.Title""" +an instance of :class:`plotly.graph_objs.surface.colorbar.Title`""" ) # Handle skip_invalid @@ -390,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.surface.colorb + ar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -442,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.surface.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,7 +644,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.surface.colorbar.Tickfont + :class:`plotly.graph_objs.surface.colorbar.Tickfont` color family @@ -682,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.surface.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/__init__.py index ca598da9e19..85bab936142 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.surface.colorbar.title.Font + :class:`plotly.graph_objs.surface.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.surface.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/contours/__init__.py index 23cc7247a76..3a03f1aa555 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/contours/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/contours/__init__.py @@ -191,7 +191,7 @@ def project(self): """ The 'project' property is an instance of Project that may be specified as: - - An instance of plotly.graph_objs.surface.contours.z.Project + - An instance of :class:`plotly.graph_objs.surface.contours.z.Project` - A dict of string/value properties that will be passed to the Project constructor @@ -353,8 +353,8 @@ def _prop_descriptions(self): highlightwidth Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.z.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.z.Project + ` instance or dict with compatible properties show Determines whether or not contour lines about the z dimension are drawn. @@ -394,7 +394,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.contours.Z + an instance of + :class:`plotly.graph_objs.surface.contours.Z` color Sets the color of the contour lines. end @@ -408,8 +409,8 @@ def __init__( highlightwidth Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.z.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.z.Project + ` instance or dict with compatible properties show Determines whether or not contour lines about the z dimension are drawn. @@ -444,7 +445,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.contours.Z constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.Z""" +an instance of :class:`plotly.graph_objs.surface.contours.Z`""" ) # Handle skip_invalid @@ -696,7 +697,7 @@ def project(self): """ The 'project' property is an instance of Project that may be specified as: - - An instance of plotly.graph_objs.surface.contours.y.Project + - An instance of :class:`plotly.graph_objs.surface.contours.y.Project` - A dict of string/value properties that will be passed to the Project constructor @@ -858,8 +859,8 @@ def _prop_descriptions(self): highlightwidth Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.y.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.y.Project + ` instance or dict with compatible properties show Determines whether or not contour lines about the y dimension are drawn. @@ -899,7 +900,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.contours.Y + an instance of + :class:`plotly.graph_objs.surface.contours.Y` color Sets the color of the contour lines. end @@ -913,8 +915,8 @@ def __init__( highlightwidth Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.y.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.y.Project + ` instance or dict with compatible properties show Determines whether or not contour lines about the y dimension are drawn. @@ -949,7 +951,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.contours.Y constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.Y""" +an instance of :class:`plotly.graph_objs.surface.contours.Y`""" ) # Handle skip_invalid @@ -1201,7 +1203,7 @@ def project(self): """ The 'project' property is an instance of Project that may be specified as: - - An instance of plotly.graph_objs.surface.contours.x.Project + - An instance of :class:`plotly.graph_objs.surface.contours.x.Project` - A dict of string/value properties that will be passed to the Project constructor @@ -1363,8 +1365,8 @@ def _prop_descriptions(self): highlightwidth Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.x.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.x.Project + ` instance or dict with compatible properties show Determines whether or not contour lines about the x dimension are drawn. @@ -1404,7 +1406,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.contours.X + an instance of + :class:`plotly.graph_objs.surface.contours.X` color Sets the color of the contour lines. end @@ -1418,8 +1421,8 @@ def __init__( highlightwidth Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.x.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.x.Project + ` instance or dict with compatible properties show Determines whether or not contour lines about the x dimension are drawn. @@ -1454,7 +1457,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.contours.X constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.X""" +an instance of :class:`plotly.graph_objs.surface.contours.X`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/x/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/contours/x/__init__.py index 4d1ad1abd6d..62baff49d73 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/contours/x/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/contours/x/__init__.py @@ -113,7 +113,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.surface.contours.x.Project + :class:`plotly.graph_objs.surface.contours.x.Project` x Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to True @@ -152,7 +152,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.contours.x.Project constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.x.Project""" +an instance of :class:`plotly.graph_objs.surface.contours.x.Project`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/y/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/contours/y/__init__.py index 09429764535..92d07f22794 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/contours/y/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/contours/y/__init__.py @@ -113,7 +113,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.surface.contours.y.Project + :class:`plotly.graph_objs.surface.contours.y.Project` x Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to True @@ -152,7 +152,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.contours.y.Project constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.y.Project""" +an instance of :class:`plotly.graph_objs.surface.contours.y.Project`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/z/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/contours/z/__init__.py index 92bf751fac5..491ca43ace3 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/contours/z/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/contours/z/__init__.py @@ -113,7 +113,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.surface.contours.z.Project + :class:`plotly.graph_objs.surface.contours.z.Project` x Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to True @@ -152,7 +152,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.surface.contours.z.Project constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.z.Project""" +an instance of :class:`plotly.graph_objs.surface.contours.z.Project`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/__init__.py index 461726715e6..58c97d7a3f3 100644 --- a/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.surface.hoverlabel.Font + :class:`plotly.graph_objs.surface.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.surface.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.surface.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.surface.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/table/__init__.py b/packages/python/plotly/plotly/graph_objs/table/__init__.py index 4b6fb4d7dc1..1052ed4ea60 100644 --- a/packages/python/plotly/plotly/graph_objs/table/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/table/__init__.py @@ -77,7 +77,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Stream + an instance of :class:`plotly.graph_objs.table.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -107,7 +107,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.table.Stream constructor must be a dict or -an instance of plotly.graph_objs.table.Stream""" +an instance of :class:`plotly.graph_objs.table.Stream`""" ) # Handle skip_invalid @@ -358,7 +358,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.table.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.table.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -513,7 +513,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Hoverlabel + an instance of + :class:`plotly.graph_objs.table.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -562,7 +563,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.table.Hoverlabel""" +an instance of :class:`plotly.graph_objs.table.Hoverlabel`""" ) # Handle skip_invalid @@ -673,7 +674,7 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of plotly.graph_objs.table.header.Fill + - An instance of :class:`plotly.graph_objs.table.header.Fill` - A dict of string/value properties that will be passed to the Fill constructor @@ -704,7 +705,7 @@ def font(self): """ The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.table.header.Font + - An instance of :class:`plotly.graph_objs.table.header.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -820,7 +821,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.table.header.Line + - An instance of :class:`plotly.graph_objs.table.header.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -994,11 +995,11 @@ def _prop_descriptions(self): alignsrc Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.header.Fill instance or dict - with compatible properties + :class:`plotly.graph_objects.table.header.Fill` + instance or dict with compatible properties font - plotly.graph_objects.table.header.Font instance or dict - with compatible properties + :class:`plotly.graph_objects.table.header.Font` + instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See @@ -1009,8 +1010,8 @@ def _prop_descriptions(self): height The height of cells. line - plotly.graph_objects.table.header.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.table.header.Line` + instance or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -1055,7 +1056,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Header + an instance of :class:`plotly.graph_objs.table.Header` align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more @@ -1065,11 +1066,11 @@ def __init__( alignsrc Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.header.Fill instance or dict - with compatible properties + :class:`plotly.graph_objects.table.header.Fill` + instance or dict with compatible properties font - plotly.graph_objects.table.header.Font instance or dict - with compatible properties + :class:`plotly.graph_objects.table.header.Font` + instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See @@ -1080,8 +1081,8 @@ def __init__( height The height of cells. line - plotly.graph_objects.table.header.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.table.header.Line` + instance or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -1118,7 +1119,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.Header constructor must be a dict or -an instance of plotly.graph_objs.table.Header""" +an instance of :class:`plotly.graph_objs.table.Header`""" ) # Handle skip_invalid @@ -1321,7 +1322,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Domain + an instance of :class:`plotly.graph_objs.table.Domain` column If there is a layout grid, use the domain for this column in the grid for this table trace . @@ -1354,7 +1355,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.table.Domain constructor must be a dict or -an instance of plotly.graph_objs.table.Domain""" +an instance of :class:`plotly.graph_objs.table.Domain`""" ) # Handle skip_invalid @@ -1450,7 +1451,7 @@ def fill(self): """ The 'fill' property is an instance of Fill that may be specified as: - - An instance of plotly.graph_objs.table.cells.Fill + - An instance of :class:`plotly.graph_objs.table.cells.Fill` - A dict of string/value properties that will be passed to the Fill constructor @@ -1481,7 +1482,7 @@ def font(self): """ The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.table.cells.Font + - An instance of :class:`plotly.graph_objs.table.cells.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1597,7 +1598,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.table.cells.Line + - An instance of :class:`plotly.graph_objs.table.cells.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1771,11 +1772,11 @@ def _prop_descriptions(self): alignsrc Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.cells.Fill instance or dict - with compatible properties + :class:`plotly.graph_objects.table.cells.Fill` instance + or dict with compatible properties font - plotly.graph_objects.table.cells.Font instance or dict - with compatible properties + :class:`plotly.graph_objects.table.cells.Font` instance + or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See @@ -1786,8 +1787,8 @@ def _prop_descriptions(self): height The height of cells. line - plotly.graph_objects.table.cells.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.table.cells.Line` instance + or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -1832,7 +1833,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Cells + an instance of :class:`plotly.graph_objs.table.Cells` align Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more @@ -1842,11 +1843,11 @@ def __init__( alignsrc Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.cells.Fill instance or dict - with compatible properties + :class:`plotly.graph_objects.table.cells.Fill` instance + or dict with compatible properties font - plotly.graph_objects.table.cells.Font instance or dict - with compatible properties + :class:`plotly.graph_objects.table.cells.Font` instance + or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See @@ -1857,8 +1858,8 @@ def __init__( height The height of cells. line - plotly.graph_objects.table.cells.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.table.cells.Line` instance + or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -1895,7 +1896,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.Cells constructor must be a dict or -an instance of plotly.graph_objs.table.Cells""" +an instance of :class:`plotly.graph_objs.table.Cells`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/table/cells/__init__.py b/packages/python/plotly/plotly/graph_objs/table/cells/__init__.py index 90a79a7ed83..840fbe7afba 100644 --- a/packages/python/plotly/plotly/graph_objs/table/cells/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/table/cells/__init__.py @@ -152,7 +152,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.cells.Line + an instance of + :class:`plotly.graph_objs.table.cells.Line` color colorsrc @@ -181,7 +182,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.cells.Line constructor must be a dict or -an instance of plotly.graph_objs.table.cells.Line""" +an instance of :class:`plotly.graph_objs.table.cells.Line`""" ) # Handle skip_invalid @@ -449,7 +450,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.cells.Font + an instance of + :class:`plotly.graph_objs.table.cells.Font` color colorsrc @@ -494,7 +496,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.cells.Font constructor must be a dict or -an instance of plotly.graph_objs.table.cells.Font""" +an instance of :class:`plotly.graph_objs.table.cells.Font`""" ) # Handle skip_invalid @@ -651,7 +653,8 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.cells.Fill + an instance of + :class:`plotly.graph_objs.table.cells.Fill` color Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors. @@ -677,7 +680,7 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): """\ The first argument to the plotly.graph_objs.table.cells.Fill constructor must be a dict or -an instance of plotly.graph_objs.table.cells.Fill""" +an instance of :class:`plotly.graph_objs.table.cells.Fill`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/table/header/__init__.py b/packages/python/plotly/plotly/graph_objs/table/header/__init__.py index a498a223e35..90a8aea1313 100644 --- a/packages/python/plotly/plotly/graph_objs/table/header/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/table/header/__init__.py @@ -152,7 +152,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.header.Line + an instance of + :class:`plotly.graph_objs.table.header.Line` color colorsrc @@ -181,7 +182,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.header.Line constructor must be a dict or -an instance of plotly.graph_objs.table.header.Line""" +an instance of :class:`plotly.graph_objs.table.header.Line`""" ) # Handle skip_invalid @@ -449,7 +450,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.header.Font + an instance of + :class:`plotly.graph_objs.table.header.Font` color colorsrc @@ -494,7 +496,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.header.Font constructor must be a dict or -an instance of plotly.graph_objs.table.header.Font""" +an instance of :class:`plotly.graph_objs.table.header.Font`""" ) # Handle skip_invalid @@ -651,7 +653,8 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.header.Fill + an instance of + :class:`plotly.graph_objs.table.header.Fill` color Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors. @@ -677,7 +680,7 @@ def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): """\ The first argument to the plotly.graph_objs.table.header.Fill constructor must be a dict or -an instance of plotly.graph_objs.table.header.Fill""" +an instance of :class:`plotly.graph_objs.table.header.Fill`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/table/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/table/hoverlabel/__init__.py index c43c783ba04..1a4af353bfe 100644 --- a/packages/python/plotly/plotly/graph_objs/table/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/table/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.table.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.table.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.table.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.table.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/treemap/__init__.py b/packages/python/plotly/plotly/graph_objs/treemap/__init__.py index 512da9c1d1c..65c94a6cd6e 100644 --- a/packages/python/plotly/plotly/graph_objs/treemap/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/treemap/__init__.py @@ -145,7 +145,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Tiling + an instance of + :class:`plotly.graph_objs.treemap.Tiling` flip Determines if the positions obtained from solver are flipped on each axis. @@ -188,7 +189,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Tiling constructor must be a dict or -an instance of plotly.graph_objs.treemap.Tiling""" +an instance of :class:`plotly.graph_objs.treemap.Tiling`""" ) # Handle skip_invalid @@ -458,7 +459,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Textfont + an instance of + :class:`plotly.graph_objs.treemap.Textfont` color colorsrc @@ -503,7 +505,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Textfont constructor must be a dict or -an instance of plotly.graph_objs.treemap.Textfont""" +an instance of :class:`plotly.graph_objs.treemap.Textfont`""" ) # Handle skip_invalid @@ -626,7 +628,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Stream + an instance of + :class:`plotly.graph_objs.treemap.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -656,7 +659,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.treemap.Stream constructor must be a dict or -an instance of plotly.graph_objs.treemap.Stream""" +an instance of :class:`plotly.graph_objs.treemap.Stream`""" ) # Handle skip_invalid @@ -749,7 +752,7 @@ def textfont(self): The 'textfont' property is an instance of Textfont that may be specified as: - - An instance of plotly.graph_objs.treemap.pathbar.Textfont + - An instance of :class:`plotly.graph_objs.treemap.pathbar.Textfont` - A dict of string/value properties that will be passed to the Textfont constructor @@ -883,7 +886,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Pathbar + an instance of + :class:`plotly.graph_objs.treemap.Pathbar` edgeshape Determines which shape is used for edges between `barpath` labels. @@ -919,7 +923,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Pathbar constructor must be a dict or -an instance of plotly.graph_objs.treemap.Pathbar""" +an instance of :class:`plotly.graph_objs.treemap.Pathbar`""" ) # Handle skip_invalid @@ -1197,7 +1201,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.treemap.Outsidetextfont + :class:`plotly.graph_objs.treemap.Outsidetextfont` color colorsrc @@ -1242,7 +1246,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Outsidetextfont constructor must be a dict or -an instance of plotly.graph_objs.treemap.Outsidetextfont""" +an instance of :class:`plotly.graph_objs.treemap.Outsidetextfont`""" ) # Handle skip_invalid @@ -1444,7 +1448,7 @@ def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.ColorBar + - An instance of :class:`plotly.graph_objs.treemap.marker.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor @@ -1576,9 +1580,9 @@ def colorbar(self): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.treemap.marker. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.treemap + .marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.treemap.marker.colorbar.tickformatstopdefault @@ -1625,8 +1629,9 @@ def colorbar(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.treemap.marker.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use treemap.marker.colorbar.title.font instead. @@ -1801,7 +1806,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.Line + - An instance of :class:`plotly.graph_objs.treemap.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1837,7 +1842,7 @@ def pad(self): """ The 'pad' property is an instance of Pad that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.Pad + - An instance of :class:`plotly.graph_objs.treemap.marker.Pad` - A dict of string/value properties that will be passed to the Pad constructor @@ -1957,8 +1962,8 @@ def _prop_descriptions(self): `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.treemap.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.ColorBar` + instance or dict with compatible properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick @@ -1990,11 +1995,11 @@ def _prop_descriptions(self): while the leaves are faded towards the background color. line - plotly.graph_objects.treemap.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Line` + instance or dict with compatible properties pad - plotly.graph_objects.treemap.marker.Pad instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Pad` + instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical array. If true, @@ -2034,7 +2039,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Marker + an instance of + :class:`plotly.graph_objs.treemap.Marker` autocolorscale Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by @@ -2075,8 +2081,8 @@ def __init__( `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. colorbar - plotly.graph_objects.treemap.marker.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.ColorBar` + instance or dict with compatible properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick @@ -2108,11 +2114,11 @@ def __init__( while the leaves are faded towards the background color. line - plotly.graph_objects.treemap.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Line` + instance or dict with compatible properties pad - plotly.graph_objects.treemap.marker.Pad instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Pad` + instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical array. If true, @@ -2143,7 +2149,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Marker constructor must be a dict or -an instance of plotly.graph_objs.treemap.Marker""" +an instance of :class:`plotly.graph_objs.treemap.Marker`""" ) # Handle skip_invalid @@ -2446,7 +2452,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Insidetextfont + an instance of + :class:`plotly.graph_objs.treemap.Insidetextfont` color colorsrc @@ -2491,7 +2498,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.treemap.Insidetextfont""" +an instance of :class:`plotly.graph_objs.treemap.Insidetextfont`""" ) # Handle skip_invalid @@ -2754,7 +2761,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.treemap.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.treemap.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -2909,7 +2916,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Hoverlabel + an instance of + :class:`plotly.graph_objs.treemap.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -2958,7 +2966,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.treemap.Hoverlabel""" +an instance of :class:`plotly.graph_objs.treemap.Hoverlabel`""" ) # Handle skip_invalid @@ -3146,7 +3154,8 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.Domain + an instance of + :class:`plotly.graph_objs.treemap.Domain` column If there is a layout grid, use the domain for this column in the grid for this treemap trace . @@ -3179,7 +3188,7 @@ def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): """\ The first argument to the plotly.graph_objs.treemap.Domain constructor must be a dict or -an instance of plotly.graph_objs.treemap.Domain""" +an instance of :class:`plotly.graph_objs.treemap.Domain`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/__init__.py index 60f4fd92422..29d432e8ddc 100644 --- a/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.treemap.hoverlabel.Font + :class:`plotly.graph_objs.treemap.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.treemap.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.treemap.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/__init__.py index 309f76474e6..643c24163ac 100644 --- a/packages/python/plotly/plotly/graph_objs/treemap/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/__init__.py @@ -113,7 +113,8 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.marker.Pad + an instance of + :class:`plotly.graph_objs.treemap.marker.Pad` b Sets the padding form the bottom (in px). l @@ -142,7 +143,7 @@ def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): """\ The first argument to the plotly.graph_objs.treemap.marker.Pad constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.Pad""" +an instance of :class:`plotly.graph_objs.treemap.marker.Pad`""" ) # Handle skip_invalid @@ -341,7 +342,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.marker.Line + an instance of + :class:`plotly.graph_objs.treemap.marker.Line` color Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value. @@ -372,7 +374,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.Line""" +an instance of :class:`plotly.graph_objs.treemap.marker.Line`""" ) # Handle skip_invalid @@ -1037,7 +1039,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -1171,7 +1173,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -1409,7 +1411,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.colorbar.Title + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -1453,7 +1455,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1762,9 +1764,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.treemap.marker.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.treemap.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.treema p.marker.colorbar.tickformatstopdefaults), sets the @@ -1804,8 +1806,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.treemap.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use treemap.marker.colorbar.title.font instead. Sets this @@ -1900,7 +1902,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.treemap.marker.ColorBar + :class:`plotly.graph_objs.treemap.marker.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -2013,9 +2015,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.treemap.marker.colorbar - .Tickformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.treemap.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.data.treema p.marker.colorbar.tickformatstopdefaults), sets the @@ -2055,8 +2057,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.treemap.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.colorbar.Ti + tle` instance or dict with compatible properties titlefont Deprecated: Please use treemap.marker.colorbar.title.font instead. Sets this @@ -2108,7 +2110,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.marker.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.ColorBar""" +an instance of :class:`plotly.graph_objs.treemap.marker.ColorBar`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/__init__.py index 39d7dfcfd0b..0ac6efeadf1 100644 --- a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.treemap.marker.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,8 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.treemap.marker.colorbar.Title + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -167,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.treemap.marker.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.colorbar.Title""" +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Title`""" ) # Handle skip_invalid @@ -391,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.treemap.marker.colorba - r.Tickformatstop + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -443,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.marker.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -643,8 +643,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.treemap.marker.colorbar.Tickfont + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.Tickfont` color family @@ -683,7 +683,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.treemap.marker.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py index 9f0052292bb..3111d92cb63 100644 --- a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py @@ -152,8 +152,8 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.treemap.marker.colorbar.title.Font + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.treemap.marker.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.treemap.marker.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/treemap/pathbar/__init__.py b/packages/python/plotly/plotly/graph_objs/treemap/pathbar/__init__.py index 0b7a246cf81..ecfebb44d58 100644 --- a/packages/python/plotly/plotly/graph_objs/treemap/pathbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/treemap/pathbar/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.treemap.pathbar.Textfont + :class:`plotly.graph_objs.treemap.pathbar.Textfont` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.treemap.pathbar.Textfont constructor must be a dict or -an instance of plotly.graph_objs.treemap.pathbar.Textfont""" +an instance of :class:`plotly.graph_objs.treemap.pathbar.Textfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/violin/__init__.py b/packages/python/plotly/plotly/graph_objs/violin/__init__.py index 872520cb197..02e509c4985 100644 --- a/packages/python/plotly/plotly/graph_objs/violin/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/violin/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.violin.unselected.Marker + - An instance of :class:`plotly.graph_objs.violin.unselected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -49,8 +49,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.violin.unselected.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.unselected.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -61,10 +61,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Unselected + an instance of + :class:`plotly.graph_objs.violin.Unselected` marker - plotly.graph_objects.violin.unselected.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.unselected.Marker` + instance or dict with compatible properties Returns ------- @@ -85,7 +86,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.Unselected constructor must be a dict or -an instance of plotly.graph_objs.violin.Unselected""" +an instance of :class:`plotly.graph_objs.violin.Unselected`""" ) # Handle skip_invalid @@ -193,7 +194,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Stream + an instance of :class:`plotly.graph_objs.violin.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -223,7 +224,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.Stream constructor must be a dict or -an instance of plotly.graph_objs.violin.Stream""" +an instance of :class:`plotly.graph_objs.violin.Stream`""" ) # Handle skip_invalid @@ -268,7 +269,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.violin.selected.Marker + - An instance of :class:`plotly.graph_objs.violin.selected.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -303,8 +304,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.violin.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.selected.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -315,10 +316,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Selected + an instance of + :class:`plotly.graph_objs.violin.Selected` marker - plotly.graph_objects.violin.selected.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.selected.Marker` + instance or dict with compatible properties Returns ------- @@ -339,7 +341,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.Selected constructor must be a dict or -an instance of plotly.graph_objs.violin.Selected""" +an instance of :class:`plotly.graph_objs.violin.Selected`""" ) # Handle skip_invalid @@ -507,7 +509,8 @@ def __init__(self, arg=None, color=None, visible=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Meanline + an instance of + :class:`plotly.graph_objs.violin.Meanline` color Sets the mean line color. visible @@ -538,7 +541,7 @@ def __init__(self, arg=None, color=None, visible=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.Meanline constructor must be a dict or -an instance of plotly.graph_objs.violin.Meanline""" +an instance of :class:`plotly.graph_objs.violin.Meanline`""" ) # Handle skip_invalid @@ -648,7 +651,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.violin.marker.Line + - An instance of :class:`plotly.graph_objs.violin.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -882,8 +885,8 @@ def _prop_descriptions(self): array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.violin.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -916,7 +919,7 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Marker + an instance of :class:`plotly.graph_objs.violin.Marker` color Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the @@ -924,8 +927,8 @@ def __init__( array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.violin.marker.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -958,7 +961,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.violin.Marker constructor must be a dict or -an instance of plotly.graph_objs.violin.Marker""" +an instance of :class:`plotly.graph_objs.violin.Marker`""" ) # Handle skip_invalid @@ -1112,7 +1115,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Line + an instance of :class:`plotly.graph_objs.violin.Line` color Sets the color of line bounding the violin(s). width @@ -1137,7 +1140,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.Line constructor must be a dict or -an instance of plotly.graph_objs.violin.Line""" +an instance of :class:`plotly.graph_objs.violin.Line`""" ) # Handle skip_invalid @@ -1388,7 +1391,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.violin.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.violin.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1543,7 +1546,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Hoverlabel + an instance of + :class:`plotly.graph_objs.violin.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1592,7 +1596,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.violin.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.violin.Hoverlabel""" +an instance of :class:`plotly.graph_objs.violin.Hoverlabel`""" ) # Handle skip_invalid @@ -1717,7 +1721,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.violin.box.Line + - An instance of :class:`plotly.graph_objs.violin.box.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -1795,8 +1799,8 @@ def _prop_descriptions(self): fillcolor Sets the inner box plot fill color. line - plotly.graph_objects.violin.box.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.box.Line` instance + or dict with compatible properties visible Determines if an miniature box plot is drawn inside the violins. @@ -1816,12 +1820,12 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Box + an instance of :class:`plotly.graph_objs.violin.Box` fillcolor Sets the inner box plot fill color. line - plotly.graph_objects.violin.box.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.violin.box.Line` instance + or dict with compatible properties visible Determines if an miniature box plot is drawn inside the violins. @@ -1849,7 +1853,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.violin.Box constructor must be a dict or -an instance of plotly.graph_objs.violin.Box""" +an instance of :class:`plotly.graph_objs.violin.Box`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/violin/box/__init__.py b/packages/python/plotly/plotly/graph_objs/violin/box/__init__.py index e2af1194f8d..2aff47d1ca2 100644 --- a/packages/python/plotly/plotly/graph_objs/violin/box/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/violin/box/__init__.py @@ -108,7 +108,8 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.box.Line + an instance of + :class:`plotly.graph_objs.violin.box.Line` color Sets the inner box plot bounding line color. width @@ -133,7 +134,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.box.Line constructor must be a dict or -an instance of plotly.graph_objs.violin.box.Line""" +an instance of :class:`plotly.graph_objs.violin.box.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/__init__.py index 6057dd495de..737774d3dd3 100644 --- a/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.violin.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.violin.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.violin.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.violin.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/violin/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/violin/marker/__init__.py index 65c6657c30d..51c23240e70 100644 --- a/packages/python/plotly/plotly/graph_objs/violin/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/violin/marker/__init__.py @@ -211,7 +211,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.marker.Line + an instance of + :class:`plotly.graph_objs.violin.marker.Line` color Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the @@ -247,7 +248,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.violin.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.violin.marker.Line""" +an instance of :class:`plotly.graph_objs.violin.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/violin/selected/__init__.py b/packages/python/plotly/plotly/graph_objs/violin/selected/__init__.py index 5d194fd85c2..5ca73b8dd96 100644 --- a/packages/python/plotly/plotly/graph_objs/violin/selected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/violin/selected/__init__.py @@ -130,7 +130,8 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.selected.Marker + an instance of + :class:`plotly.graph_objs.violin.selected.Marker` color Sets the marker color of selected points. opacity @@ -157,7 +158,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.selected.Marker constructor must be a dict or -an instance of plotly.graph_objs.violin.selected.Marker""" +an instance of :class:`plotly.graph_objs.violin.selected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/violin/unselected/__init__.py b/packages/python/plotly/plotly/graph_objs/violin/unselected/__init__.py index bfdf7a8f46e..bde219f89e2 100644 --- a/packages/python/plotly/plotly/graph_objs/violin/unselected/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/violin/unselected/__init__.py @@ -137,7 +137,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.violin.unselected.Marker + :class:`plotly.graph_objs.violin.unselected.Marker` color Sets the marker color of unselected points, applied only when a selection exists. @@ -167,7 +167,7 @@ def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.violin.unselected.Marker constructor must be a dict or -an instance of plotly.graph_objs.violin.unselected.Marker""" +an instance of :class:`plotly.graph_objs.violin.unselected.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/volume/__init__.py b/packages/python/plotly/plotly/graph_objs/volume/__init__.py index e776febe864..d19243f1cdb 100644 --- a/packages/python/plotly/plotly/graph_objs/volume/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/volume/__init__.py @@ -145,7 +145,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Surface + an instance of + :class:`plotly.graph_objs.volume.Surface` count Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning @@ -189,7 +190,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.Surface constructor must be a dict or -an instance of plotly.graph_objs.volume.Surface""" +an instance of :class:`plotly.graph_objs.volume.Surface`""" ) # Handle skip_invalid @@ -306,7 +307,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Stream + an instance of :class:`plotly.graph_objs.volume.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -336,7 +337,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.Stream constructor must be a dict or -an instance of plotly.graph_objs.volume.Stream""" +an instance of :class:`plotly.graph_objs.volume.Stream`""" ) # Handle skip_invalid @@ -450,7 +451,8 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Spaceframe + an instance of + :class:`plotly.graph_objs.volume.Spaceframe` fill Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely @@ -481,7 +483,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.Spaceframe constructor must be a dict or -an instance of plotly.graph_objs.volume.Spaceframe""" +an instance of :class:`plotly.graph_objs.volume.Spaceframe`""" ) # Handle skip_invalid @@ -526,7 +528,7 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of plotly.graph_objs.volume.slices.X + - An instance of :class:`plotly.graph_objs.volume.slices.X` - A dict of string/value properties that will be passed to the X constructor @@ -568,7 +570,7 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of plotly.graph_objs.volume.slices.Y + - An instance of :class:`plotly.graph_objs.volume.slices.Y` - A dict of string/value properties that will be passed to the Y constructor @@ -610,7 +612,7 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of plotly.graph_objs.volume.slices.Z + - An instance of :class:`plotly.graph_objs.volume.slices.Z` - A dict of string/value properties that will be passed to the Z constructor @@ -657,14 +659,14 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ x - plotly.graph_objects.volume.slices.X instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.slices.X` instance + or dict with compatible properties y - plotly.graph_objects.volume.slices.Y instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.slices.Y` instance + or dict with compatible properties z - plotly.graph_objects.volume.slices.Z instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.slices.Z` instance + or dict with compatible properties """ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): @@ -675,16 +677,16 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Slices + an instance of :class:`plotly.graph_objs.volume.Slices` x - plotly.graph_objects.volume.slices.X instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.slices.X` instance + or dict with compatible properties y - plotly.graph_objects.volume.slices.Y instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.slices.Y` instance + or dict with compatible properties z - plotly.graph_objects.volume.slices.Z instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.slices.Z` instance + or dict with compatible properties Returns ------- @@ -705,7 +707,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.Slices constructor must be a dict or -an instance of plotly.graph_objs.volume.Slices""" +an instance of :class:`plotly.graph_objs.volume.Slices`""" ) # Handle skip_invalid @@ -836,7 +838,8 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Lightposition + an instance of + :class:`plotly.graph_objs.volume.Lightposition` x Numeric vector, representing the X coordinate for each vertex. @@ -866,7 +869,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.Lightposition constructor must be a dict or -an instance of plotly.graph_objs.volume.Lightposition""" +an instance of :class:`plotly.graph_objs.volume.Lightposition`""" ) # Handle skip_invalid @@ -1110,7 +1113,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Lighting + an instance of + :class:`plotly.graph_objs.volume.Lighting` ambient Ambient light increases overall color visibility but can wash out the image. @@ -1154,7 +1158,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.Lighting constructor must be a dict or -an instance of plotly.graph_objs.volume.Lighting""" +an instance of :class:`plotly.graph_objs.volume.Lighting`""" ) # Handle skip_invalid @@ -1428,7 +1432,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.volume.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.volume.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1583,7 +1587,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Hoverlabel + an instance of + :class:`plotly.graph_objs.volume.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1632,7 +1637,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.volume.Hoverlabel""" +an instance of :class:`plotly.graph_objs.volume.Hoverlabel`""" ) # Handle skip_invalid @@ -1817,7 +1822,8 @@ def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Contour + an instance of + :class:`plotly.graph_objs.volume.Contour` color Sets the color of the contour lines. show @@ -1844,7 +1850,7 @@ def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.Contour constructor must be a dict or -an instance of plotly.graph_objs.volume.Contour""" +an instance of :class:`plotly.graph_objs.volume.Contour`""" ) # Handle skip_invalid @@ -2506,7 +2512,7 @@ def tickfont(self): The 'tickfont' property is an instance of Tickfont that may be specified as: - - An instance of plotly.graph_objs.volume.colorbar.Tickfont + - An instance of :class:`plotly.graph_objs.volume.colorbar.Tickfont` - A dict of string/value properties that will be passed to the Tickfont constructor @@ -2640,7 +2646,7 @@ def tickformatstopdefaults(self): The 'tickformatstopdefaults' property is an instance of Tickformatstop that may be specified as: - - An instance of plotly.graph_objs.volume.colorbar.Tickformatstop + - An instance of :class:`plotly.graph_objs.volume.colorbar.Tickformatstop` - A dict of string/value properties that will be passed to the Tickformatstop constructor @@ -2878,7 +2884,7 @@ def title(self): """ The 'title' property is an instance of Title that may be specified as: - - An instance of plotly.graph_objs.volume.colorbar.Title + - An instance of :class:`plotly.graph_objs.volume.colorbar.Title` - A dict of string/value properties that will be passed to the Title constructor @@ -2921,7 +2927,7 @@ def titlefont(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.volume.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.volume.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -3230,9 +3236,9 @@ def _prop_descriptions(self): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.volume.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.volume.colorbar + .Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.volume .colorbar.tickformatstopdefaults), sets the default @@ -3272,8 +3278,8 @@ def _prop_descriptions(self): tickwidth Sets the tick width (in px). title - plotly.graph_objects.volume.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use volume.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -3367,7 +3373,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.ColorBar + an instance of + :class:`plotly.graph_objs.volume.ColorBar` bgcolor Sets the color of padded area. bordercolor @@ -3480,9 +3487,9 @@ def __init__( 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of - plotly.graph_objects.volume.colorbar.Tickformatstop - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.volume.colorbar + .Tickformatstop` instances or dicts with compatible + properties tickformatstopdefaults When used in a template (as layout.template.data.volume .colorbar.tickformatstopdefaults), sets the default @@ -3522,8 +3529,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.volume.colorbar.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.colorbar.Title` + instance or dict with compatible properties titlefont Deprecated: Please use volume.colorbar.title.font instead. Sets this color bar's title font. Note that @@ -3575,7 +3582,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.ColorBar constructor must be a dict or -an instance of plotly.graph_objs.volume.ColorBar""" +an instance of :class:`plotly.graph_objs.volume.ColorBar`""" ) # Handle skip_invalid @@ -3751,7 +3758,7 @@ def x(self): """ The 'x' property is an instance of X that may be specified as: - - An instance of plotly.graph_objs.volume.caps.X + - An instance of :class:`plotly.graph_objs.volume.caps.X` - A dict of string/value properties that will be passed to the X constructor @@ -3788,7 +3795,7 @@ def y(self): """ The 'y' property is an instance of Y that may be specified as: - - An instance of plotly.graph_objs.volume.caps.Y + - An instance of :class:`plotly.graph_objs.volume.caps.Y` - A dict of string/value properties that will be passed to the Y constructor @@ -3825,7 +3832,7 @@ def z(self): """ The 'z' property is an instance of Z that may be specified as: - - An instance of plotly.graph_objs.volume.caps.Z + - An instance of :class:`plotly.graph_objs.volume.caps.Z` - A dict of string/value properties that will be passed to the Z constructor @@ -3867,14 +3874,14 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ x - plotly.graph_objects.volume.caps.X instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.caps.X` instance or + dict with compatible properties y - plotly.graph_objects.volume.caps.Y instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.caps.Y` instance or + dict with compatible properties z - plotly.graph_objects.volume.caps.Z instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.caps.Z` instance or + dict with compatible properties """ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): @@ -3885,16 +3892,16 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.Caps + an instance of :class:`plotly.graph_objs.volume.Caps` x - plotly.graph_objects.volume.caps.X instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.caps.X` instance or + dict with compatible properties y - plotly.graph_objects.volume.caps.Y instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.caps.Y` instance or + dict with compatible properties z - plotly.graph_objects.volume.caps.Z instance or dict - with compatible properties + :class:`plotly.graph_objects.volume.caps.Z` instance or + dict with compatible properties Returns ------- @@ -3915,7 +3922,7 @@ def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.Caps constructor must be a dict or -an instance of plotly.graph_objs.volume.Caps""" +an instance of :class:`plotly.graph_objs.volume.Caps`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/volume/caps/__init__.py b/packages/python/plotly/plotly/graph_objs/volume/caps/__init__.py index 56c888999e8..c63ef0784ea 100644 --- a/packages/python/plotly/plotly/graph_objs/volume/caps/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/volume/caps/__init__.py @@ -83,7 +83,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.caps.Z + an instance of :class:`plotly.graph_objs.volume.caps.Z` fill Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely @@ -116,7 +116,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.caps.Z constructor must be a dict or -an instance of plotly.graph_objs.volume.caps.Z""" +an instance of :class:`plotly.graph_objs.volume.caps.Z`""" ) # Handle skip_invalid @@ -233,7 +233,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.caps.Y + an instance of :class:`plotly.graph_objs.volume.caps.Y` fill Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely @@ -266,7 +266,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.caps.Y constructor must be a dict or -an instance of plotly.graph_objs.volume.caps.Y""" +an instance of :class:`plotly.graph_objs.volume.caps.Y`""" ) # Handle skip_invalid @@ -383,7 +383,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.caps.X + an instance of :class:`plotly.graph_objs.volume.caps.X` fill Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely @@ -416,7 +416,7 @@ def __init__(self, arg=None, fill=None, show=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.caps.X constructor must be a dict or -an instance of plotly.graph_objs.volume.caps.X""" +an instance of :class:`plotly.graph_objs.volume.caps.X`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/volume/colorbar/__init__.py b/packages/python/plotly/plotly/graph_objs/volume/colorbar/__init__.py index 4e70f7ee81f..02da5a1b7d0 100644 --- a/packages/python/plotly/plotly/graph_objs/volume/colorbar/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/volume/colorbar/__init__.py @@ -14,7 +14,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.volume.colorbar.title.Font + - An instance of :class:`plotly.graph_objs.volume.colorbar.title.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -131,7 +131,8 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.colorbar.Title + an instance of + :class:`plotly.graph_objs.volume.colorbar.Title` font Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` @@ -166,7 +167,7 @@ def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.colorbar.Title constructor must be a dict or -an instance of plotly.graph_objs.volume.colorbar.Title""" +an instance of :class:`plotly.graph_objs.volume.colorbar.Title`""" ) # Handle skip_invalid @@ -390,8 +391,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.volume.colorbar.Tickformatstop + an instance of :class:`plotly.graph_objs.volume.colorba + r.Tickformatstop` dtickrange range [*min*, *max*], where "min", "max" - dtick values which describe some zoom level, it is possible to omit @@ -442,7 +443,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.colorbar.Tickformatstop constructor must be a dict or -an instance of plotly.graph_objs.volume.colorbar.Tickformatstop""" +an instance of :class:`plotly.graph_objs.volume.colorbar.Tickformatstop`""" ) # Handle skip_invalid @@ -641,7 +642,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.volume.colorbar.Tickfont + :class:`plotly.graph_objs.volume.colorbar.Tickfont` color family @@ -680,7 +681,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.colorbar.Tickfont constructor must be a dict or -an instance of plotly.graph_objs.volume.colorbar.Tickfont""" +an instance of :class:`plotly.graph_objs.volume.colorbar.Tickfont`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/__init__.py b/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/__init__.py index 8f1629ebc08..f309b186f47 100644 --- a/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/__init__.py @@ -153,7 +153,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.volume.colorbar.title.Font + :class:`plotly.graph_objs.volume.colorbar.title.Font` color family @@ -192,7 +192,7 @@ def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): """\ The first argument to the plotly.graph_objs.volume.colorbar.title.Font constructor must be a dict or -an instance of plotly.graph_objs.volume.colorbar.title.Font""" +an instance of :class:`plotly.graph_objs.volume.colorbar.title.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/__init__.py index 1aa3e0d115d..691f31eb95e 100644 --- a/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/__init__.py @@ -230,7 +230,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.hoverlabel.Font + an instance of + :class:`plotly.graph_objs.volume.hoverlabel.Font` color colorsrc @@ -275,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.volume.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.volume.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/volume/slices/__init__.py b/packages/python/plotly/plotly/graph_objs/volume/slices/__init__.py index 766aae399e9..64e2889c843 100644 --- a/packages/python/plotly/plotly/graph_objs/volume/slices/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/volume/slices/__init__.py @@ -134,7 +134,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.slices.Z + an instance of + :class:`plotly.graph_objs.volume.slices.Z` fill Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are @@ -170,7 +171,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.slices.Z constructor must be a dict or -an instance of plotly.graph_objs.volume.slices.Z""" +an instance of :class:`plotly.graph_objs.volume.slices.Z`""" ) # Handle skip_invalid @@ -344,7 +345,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.slices.Y + an instance of + :class:`plotly.graph_objs.volume.slices.Y` fill Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are @@ -380,7 +382,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.slices.Y constructor must be a dict or -an instance of plotly.graph_objs.volume.slices.Y""" +an instance of :class:`plotly.graph_objs.volume.slices.Y`""" ) # Handle skip_invalid @@ -554,7 +556,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.volume.slices.X + an instance of + :class:`plotly.graph_objs.volume.slices.X` fill Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are @@ -590,7 +593,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.volume.slices.X constructor must be a dict or -an instance of plotly.graph_objs.volume.slices.X""" +an instance of :class:`plotly.graph_objs.volume.slices.X`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/__init__.py index 7a2ea51166a..7c0efb4dae2 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/__init__.py @@ -11,7 +11,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.waterfall.totals.Marker + - An instance of :class:`plotly.graph_objs.waterfall.totals.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -21,8 +21,9 @@ def marker(self): Sets the marker color of all intermediate sums and total values. line - plotly.graph_objects.waterfall.totals.marker.Li - ne instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.m + arker.Line` instance or dict with compatible + properties Returns ------- @@ -46,8 +47,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.waterfall.totals.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.Marker` + instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -58,10 +59,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Totals + an instance of + :class:`plotly.graph_objs.waterfall.Totals` marker - plotly.graph_objects.waterfall.totals.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.Marker` + instance or dict with compatible properties Returns ------- @@ -82,7 +84,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.Totals constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Totals""" +an instance of :class:`plotly.graph_objs.waterfall.Totals`""" ) # Handle skip_invalid @@ -343,7 +345,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Textfont + an instance of + :class:`plotly.graph_objs.waterfall.Textfont` color colorsrc @@ -388,7 +391,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.waterfall.Textfont constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Textfont""" +an instance of :class:`plotly.graph_objs.waterfall.Textfont`""" ) # Handle skip_invalid @@ -511,7 +514,8 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Stream + an instance of + :class:`plotly.graph_objs.waterfall.Stream` maxpoints Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to 50, @@ -541,7 +545,7 @@ def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.Stream constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Stream""" +an instance of :class:`plotly.graph_objs.waterfall.Stream`""" ) # Handle skip_invalid @@ -806,7 +810,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.Outsidetextfont + :class:`plotly.graph_objs.waterfall.Outsidetextfont` color colorsrc @@ -851,7 +855,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.waterfall.Outsidetextfont constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Outsidetextfont""" +an instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont`""" ) # Handle skip_invalid @@ -1128,7 +1132,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.Insidetextfont + :class:`plotly.graph_objs.waterfall.Insidetextfont` color colorsrc @@ -1173,7 +1177,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.waterfall.Insidetextfont constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Insidetextfont""" +an instance of :class:`plotly.graph_objs.waterfall.Insidetextfont`""" ) # Handle skip_invalid @@ -1230,7 +1234,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.waterfall.increasing.Marker + - An instance of :class:`plotly.graph_objs.waterfall.increasing.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -1239,9 +1243,9 @@ def marker(self): color Sets the marker color of all increasing values. line - plotly.graph_objects.waterfall.increasing.marke - r.Line instance or dict with compatible - properties + :class:`plotly.graph_objects.waterfall.increasi + ng.marker.Line` instance or dict with + compatible properties Returns ------- @@ -1265,8 +1269,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.waterfall.increasing.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.increasing.Marke + r` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -1277,10 +1281,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Increasing + an instance of + :class:`plotly.graph_objs.waterfall.Increasing` marker - plotly.graph_objects.waterfall.increasing.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.increasing.Marke + r` instance or dict with compatible properties Returns ------- @@ -1301,7 +1306,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.Increasing constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Increasing""" +an instance of :class:`plotly.graph_objs.waterfall.Increasing`""" ) # Handle skip_invalid @@ -1549,7 +1554,7 @@ def font(self): The 'font' property is an instance of Font that may be specified as: - - An instance of plotly.graph_objs.waterfall.hoverlabel.Font + - An instance of :class:`plotly.graph_objs.waterfall.hoverlabel.Font` - A dict of string/value properties that will be passed to the Font constructor @@ -1704,7 +1709,8 @@ def __init__( ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Hoverlabel + an instance of + :class:`plotly.graph_objs.waterfall.Hoverlabel` align Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover @@ -1753,7 +1759,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.waterfall.Hoverlabel constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Hoverlabel""" +an instance of :class:`plotly.graph_objs.waterfall.Hoverlabel`""" ) # Handle skip_invalid @@ -1819,7 +1825,7 @@ def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - - An instance of plotly.graph_objs.waterfall.decreasing.Marker + - An instance of :class:`plotly.graph_objs.waterfall.decreasing.Marker` - A dict of string/value properties that will be passed to the Marker constructor @@ -1828,9 +1834,9 @@ def marker(self): color Sets the marker color of all decreasing values. line - plotly.graph_objects.waterfall.decreasing.marke - r.Line instance or dict with compatible - properties + :class:`plotly.graph_objects.waterfall.decreasi + ng.marker.Line` instance or dict with + compatible properties Returns ------- @@ -1854,8 +1860,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ marker - plotly.graph_objects.waterfall.decreasing.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.decreasing.Marke + r` instance or dict with compatible properties """ def __init__(self, arg=None, marker=None, **kwargs): @@ -1866,10 +1872,11 @@ def __init__(self, arg=None, marker=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Decreasing + an instance of + :class:`plotly.graph_objs.waterfall.Decreasing` marker - plotly.graph_objects.waterfall.decreasing.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.decreasing.Marke + r` instance or dict with compatible properties Returns ------- @@ -1890,7 +1897,7 @@ def __init__(self, arg=None, marker=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.Decreasing constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Decreasing""" +an instance of :class:`plotly.graph_objs.waterfall.Decreasing`""" ) # Handle skip_invalid @@ -1932,7 +1939,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.waterfall.connector.Line + - An instance of :class:`plotly.graph_objs.waterfall.connector.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -2011,8 +2018,8 @@ def _parent_path_str(self): def _prop_descriptions(self): return """\ line - plotly.graph_objects.waterfall.connector.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.waterfall.connector.Line` + instance or dict with compatible properties mode Sets the shape of connector lines. visible @@ -2027,10 +2034,11 @@ def __init__(self, arg=None, line=None, mode=None, visible=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of plotly.graph_objs.waterfall.Connector + an instance of + :class:`plotly.graph_objs.waterfall.Connector` line - plotly.graph_objects.waterfall.connector.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.waterfall.connector.Line` + instance or dict with compatible properties mode Sets the shape of connector lines. visible @@ -2055,7 +2063,7 @@ def __init__(self, arg=None, line=None, mode=None, visible=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.Connector constructor must be a dict or -an instance of plotly.graph_objs.waterfall.Connector""" +an instance of :class:`plotly.graph_objs.waterfall.Connector`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/connector/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/connector/__init__.py index 14cfdba89db..e01341a52d1 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/connector/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/connector/__init__.py @@ -140,7 +140,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.connector.Line + :class:`plotly.graph_objs.waterfall.connector.Line` color Sets the line color. dash @@ -170,7 +170,7 @@ def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.connector.Line constructor must be a dict or -an instance of plotly.graph_objs.waterfall.connector.Line""" +an instance of :class:`plotly.graph_objs.waterfall.connector.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/__init__.py index 948f05357d3..733d5079b0a 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/__init__.py @@ -70,7 +70,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.waterfall.decreasing.marker.Line + - An instance of :class:`plotly.graph_objs.waterfall.decreasing.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -105,8 +105,8 @@ def _prop_descriptions(self): color Sets the marker color of all decreasing values. line - plotly.graph_objects.waterfall.decreasing.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.decreasing.marke + r.Line` instance or dict with compatible properties """ def __init__(self, arg=None, color=None, line=None, **kwargs): @@ -118,12 +118,12 @@ def __init__(self, arg=None, color=None, line=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.decreasing.Marker + :class:`plotly.graph_objs.waterfall.decreasing.Marker` color Sets the marker color of all decreasing values. line - plotly.graph_objects.waterfall.decreasing.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.decreasing.marke + r.Line` instance or dict with compatible properties Returns ------- @@ -144,7 +144,7 @@ def __init__(self, arg=None, color=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.decreasing.Marker constructor must be a dict or -an instance of plotly.graph_objs.waterfall.decreasing.Marker""" +an instance of :class:`plotly.graph_objs.waterfall.decreasing.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/__init__.py index b7d22fba812..751facc434c 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/__init__.py @@ -108,8 +108,8 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.waterfall.decreasing.marker.Line + an instance of :class:`plotly.graph_objs.waterfall.decr + easing.marker.Line` color Sets the line color of all decreasing values. width @@ -134,7 +134,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.decreasing.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.waterfall.decreasing.marker.Line""" +an instance of :class:`plotly.graph_objs.waterfall.decreasing.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/__init__.py index 4e40b934aa0..f900dd53a2f 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/__init__.py @@ -231,7 +231,7 @@ def __init__( arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.hoverlabel.Font + :class:`plotly.graph_objs.waterfall.hoverlabel.Font` color colorsrc @@ -276,7 +276,7 @@ def __init__( """\ The first argument to the plotly.graph_objs.waterfall.hoverlabel.Font constructor must be a dict or -an instance of plotly.graph_objs.waterfall.hoverlabel.Font""" +an instance of :class:`plotly.graph_objs.waterfall.hoverlabel.Font`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/__init__.py index 71355a5c066..62ffd786c78 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/__init__.py @@ -70,7 +70,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.waterfall.increasing.marker.Line + - An instance of :class:`plotly.graph_objs.waterfall.increasing.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -105,8 +105,8 @@ def _prop_descriptions(self): color Sets the marker color of all increasing values. line - plotly.graph_objects.waterfall.increasing.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.increasing.marke + r.Line` instance or dict with compatible properties """ def __init__(self, arg=None, color=None, line=None, **kwargs): @@ -118,12 +118,12 @@ def __init__(self, arg=None, color=None, line=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.increasing.Marker + :class:`plotly.graph_objs.waterfall.increasing.Marker` color Sets the marker color of all increasing values. line - plotly.graph_objects.waterfall.increasing.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.increasing.marke + r.Line` instance or dict with compatible properties Returns ------- @@ -144,7 +144,7 @@ def __init__(self, arg=None, color=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.increasing.Marker constructor must be a dict or -an instance of plotly.graph_objs.waterfall.increasing.Marker""" +an instance of :class:`plotly.graph_objs.waterfall.increasing.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/__init__.py index af0431ceb41..100a461fb24 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/__init__.py @@ -108,8 +108,8 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): ---------- arg dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.waterfall.increasing.marker.Line + an instance of :class:`plotly.graph_objs.waterfall.incr + easing.marker.Line` color Sets the line color of all increasing values. width @@ -134,7 +134,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.increasing.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.waterfall.increasing.marker.Line""" +an instance of :class:`plotly.graph_objs.waterfall.increasing.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/totals/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/totals/__init__.py index 27eeffd6b14..39ae6bdada9 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/totals/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/totals/__init__.py @@ -71,7 +71,7 @@ def line(self): """ The 'line' property is an instance of Line that may be specified as: - - An instance of plotly.graph_objs.waterfall.totals.marker.Line + - An instance of :class:`plotly.graph_objs.waterfall.totals.marker.Line` - A dict of string/value properties that will be passed to the Line constructor @@ -109,8 +109,8 @@ def _prop_descriptions(self): Sets the marker color of all intermediate sums and total values. line - plotly.graph_objects.waterfall.totals.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.marker.Li + ne` instance or dict with compatible properties """ def __init__(self, arg=None, color=None, line=None, **kwargs): @@ -122,13 +122,13 @@ def __init__(self, arg=None, color=None, line=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.totals.Marker + :class:`plotly.graph_objs.waterfall.totals.Marker` color Sets the marker color of all intermediate sums and total values. line - plotly.graph_objects.waterfall.totals.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.marker.Li + ne` instance or dict with compatible properties Returns ------- @@ -149,7 +149,7 @@ def __init__(self, arg=None, color=None, line=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.totals.Marker constructor must be a dict or -an instance of plotly.graph_objs.waterfall.totals.Marker""" +an instance of :class:`plotly.graph_objs.waterfall.totals.Marker`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/__init__.py b/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/__init__.py index c77940c5d72..4e4f9234247 100644 --- a/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/__init__.py +++ b/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/__init__.py @@ -111,7 +111,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): arg dict of properties compatible with this constructor or an instance of - plotly.graph_objs.waterfall.totals.marker.Line + :class:`plotly.graph_objs.waterfall.totals.marker.Line` color Sets the line color of all intermediate sums and total values. @@ -138,7 +138,7 @@ def __init__(self, arg=None, color=None, width=None, **kwargs): """\ The first argument to the plotly.graph_objs.waterfall.totals.marker.Line constructor must be a dict or -an instance of plotly.graph_objs.waterfall.totals.marker.Line""" +an instance of :class:`plotly.graph_objs.waterfall.totals.marker.Line`""" ) # Handle skip_invalid diff --git a/packages/python/plotly/plotly/validators/__init__.py b/packages/python/plotly/plotly/validators/__init__.py index 0704e558801..296caca5216 100644 --- a/packages/python/plotly/plotly/validators/__init__.py +++ b/packages/python/plotly/plotly/validators/__init__.py @@ -11,11 +11,11 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): "data_docs", """ angularaxis - plotly.graph_objects.layout.AngularAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.AngularAxis + ` instance or dict with compatible properties annotations A tuple of - plotly.graph_objects.layout.Annotation + :class:`plotly.graph_objects.layout.Annotation` instances or dicts with compatible properties annotationdefaults When used in a template (as @@ -94,11 +94,11 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): missing, `plotly_click` and `plotly_selected` events are not fired. coloraxis - plotly.graph_objects.layout.Coloraxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Coloraxis` + instance or dict with compatible properties colorscale - plotly.graph_objects.layout.Colorscale instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties colorway Sets the default trace colors. datarevision @@ -196,11 +196,11 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): over one another, you might need to an "opacity" to see multiple bars. geo - plotly.graph_objects.layout.Geo instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Geo` + instance or dict with compatible properties grid - plotly.graph_objects.layout.Grid instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Grid` + instance or dict with compatible properties height Sets the plot's height (in px). hiddenlabels @@ -229,8 +229,8 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): objects will not supersede hover on point-like objects in case of conflict. hoverlabel - plotly.graph_objects.layout.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties hovermode Determines the mode of hover interactions. If `clickmode` includes the "select" flag, @@ -241,7 +241,8 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): cartesian coordinates. For anything else the default value is "closest". images - A tuple of plotly.graph_objects.layout.Image + A tuple of + :class:`plotly.graph_objects.layout.Image` instances or dicts with compatible properties imagedefaults When used in a template (as @@ -249,14 +250,14 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): default property values to use for elements of layout.images legend - plotly.graph_objects.layout.Legend instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Legend` + instance or dict with compatible properties mapbox - plotly.graph_objects.layout.Mapbox instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Mapbox` + instance or dict with compatible properties margin - plotly.graph_objects.layout.Margin instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Margin` + instance or dict with compatible properties meta Assigns extra meta information that can be used in various `text` attributes. Attributes such @@ -273,8 +274,8 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): Sets the source reference on plot.ly for meta . modebar - plotly.graph_objects.layout.Modebar instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Modebar` + instance or dict with compatible properties orientation Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire @@ -293,14 +294,14 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): Sets the background color of the plotting area in-between x and y axes. polar - plotly.graph_objects.layout.Polar instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Polar` + instance or dict with compatible properties radialaxis - plotly.graph_objects.layout.RadialAxis instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.RadialAxis` + instance or dict with compatible properties scene - plotly.graph_objects.layout.Scene instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Scene` + instance or dict with compatible properties selectdirection When "dragmode" is set to "select", this limits the selection of the drag to horizontal, @@ -317,7 +318,8 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): dflt is ".," but other locales may alter this default. shapes - A tuple of plotly.graph_objects.layout.Shape + A tuple of + :class:`plotly.graph_objects.layout.Shape` instances or dicts with compatible properties shapedefaults When used in a template (as @@ -332,7 +334,8 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. sliders - A tuple of plotly.graph_objects.layout.Slider + A tuple of + :class:`plotly.graph_objects.layout.Slider` instances or dicts with compatible properties sliderdefaults When used in a template (as @@ -381,11 +384,11 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): plot, make an item with matching `templateitemname` and `visible: false`. ternary - plotly.graph_objects.layout.Ternary instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Ternary` + instance or dict with compatible properties title - plotly.graph_objects.layout.Title instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.Title` + instance or dict with compatible properties titlefont Deprecated: Please use layout.title.font instead. Sets the title font. Note that the @@ -424,11 +427,11 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): range will reset but the x axis range will retain any user-driven zoom. uniformtext - plotly.graph_objects.layout.Uniformtext - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.Uniformtext + ` instance or dict with compatible properties updatemenus A tuple of - plotly.graph_objects.layout.Updatemenu + :class:`plotly.graph_objects.layout.Updatemenu` instances or dicts with compatible properties updatemenudefaults When used in a template (as @@ -469,11 +472,11 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs): width Sets the plot's width (in px). xaxis - plotly.graph_objects.layout.XAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.XAxis` + instance or dict with compatible properties yaxis - plotly.graph_objects.layout.YAxis instance or - dict with compatible properties + :class:`plotly.graph_objects.layout.YAxis` + instance or dict with compatible properties """, ), **kwargs @@ -508,8 +511,8 @@ def __init__(self, plotly_name="waterfall", parent_name="", **kwargs): set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.waterfall.Connector - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.Connecto + r` instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -523,8 +526,8 @@ def __init__(self, plotly_name="waterfall", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.waterfall.Decreasing - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.Decreasi + ng` instance or dict with compatible properties dx Sets the x coordinate step. See `x0` for more info. @@ -541,8 +544,8 @@ def __init__(self, plotly_name="waterfall", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.waterfall.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.Hoverlab + el` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -593,8 +596,8 @@ def __init__(self, plotly_name="waterfall", parent_name="", **kwargs): idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.waterfall.Increasing - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.Increasi + ng` instance or dict with compatible properties insidetextanchor Determines if texts are kept at center or start/end points in `textposition` "inside" @@ -671,8 +674,8 @@ def __init__(self, plotly_name="waterfall", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.waterfall.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.waterfall.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string @@ -737,8 +740,8 @@ def __init__(self, plotly_name="waterfall", parent_name="", **kwargs): Sets the source reference on plot.ly for texttemplate . totals - plotly.graph_objects.waterfall.Totals instance - or dict with compatible properties + :class:`plotly.graph_objects.waterfall.Totals` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -830,8 +833,8 @@ def __init__(self, plotly_name="volume", parent_name="", **kwargs): according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.volume.Caps instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Caps` + instance or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here @@ -862,8 +865,8 @@ def __init__(self, plotly_name="volume", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.volume.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -879,8 +882,8 @@ def __init__(self, plotly_name="volume", parent_name="", **kwargs): Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth ,Electric,Viridis,Cividis. contour - plotly.graph_objects.volume.Contour instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Contour` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -904,8 +907,8 @@ def __init__(self, plotly_name="volume", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.volume.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -958,11 +961,11 @@ def __init__(self, plotly_name="volume", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.volume.Lighting instance - or dict with compatible properties - lightposition - plotly.graph_objects.volume.Lightposition + :class:`plotly.graph_objects.volume.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.volume.Lightpositi + on` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -1024,17 +1027,17 @@ def __init__(self, plotly_name="volume", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.volume.Slices instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Slices` + instance or dict with compatible properties spaceframe - plotly.graph_objects.volume.Spaceframe instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties stream - plotly.graph_objects.volume.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Stream` + instance or dict with compatible properties surface - plotly.graph_objects.volume.Surface instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.Surface` + instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a @@ -1123,8 +1126,8 @@ def __init__(self, plotly_name="violin", parent_name="", **kwargs): density estimate. By default, the bandwidth is determined by Silverman's rule of thumb. box - plotly.graph_objects.violin.Box instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.Box` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -1149,8 +1152,8 @@ def __init__(self, plotly_name="violin", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.violin.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual violins or sample points or the kernel density @@ -1209,14 +1212,14 @@ def __init__(self, plotly_name="violin", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.violin.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.Line` + instance or dict with compatible properties marker - plotly.graph_objects.violin.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.Marker` + instance or dict with compatible properties meanline - plotly.graph_objects.violin.Meanline instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.Meanline` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -1291,8 +1294,8 @@ def __init__(self, plotly_name="violin", parent_name="", **kwargs): violins are scaled by the number of sample points makingup each violin. selected - plotly.graph_objects.violin.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -1327,8 +1330,8 @@ def __init__(self, plotly_name="violin", parent_name="", **kwargs): settings, use mode "manual" and fill in the `span` attribute. stream - plotly.graph_objects.violin.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.violin.Stream` + instance or dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same @@ -1367,8 +1370,8 @@ def __init__(self, plotly_name="violin", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.violin.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -1451,8 +1454,8 @@ def __init__(self, plotly_name="treemap", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.treemap.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -1463,8 +1466,8 @@ def __init__(self, plotly_name="treemap", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.treemap.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.Hoverlabel + ` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -1530,8 +1533,8 @@ def __init__(self, plotly_name="treemap", parent_name="", **kwargs): if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.treemap.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Marker` + instance or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render @@ -1577,11 +1580,11 @@ def __init__(self, plotly_name="treemap", parent_name="", **kwargs): Sets the source reference on plot.ly for parents . pathbar - plotly.graph_objects.treemap.Pathbar instance - or dict with compatible properties + :class:`plotly.graph_objects.treemap.Pathbar` + instance or dict with compatible properties stream - plotly.graph_objects.treemap.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, @@ -1625,8 +1628,8 @@ def __init__(self, plotly_name="treemap", parent_name="", **kwargs): Sets the source reference on plot.ly for texttemplate . tiling - plotly.graph_objects.treemap.Tiling instance or - dict with compatible properties + :class:`plotly.graph_objects.treemap.Tiling` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -1684,8 +1687,8 @@ def __init__(self, plotly_name="table", parent_name="", **kwargs): "data_docs", """ cells - plotly.graph_objects.table.Cells instance or - dict with compatible properties + :class:`plotly.graph_objects.table.Cells` + instance or dict with compatible properties columnorder Specifies the rendered order of the data columns; for example, a value `2` at position @@ -1712,11 +1715,11 @@ def __init__(self, plotly_name="table", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.table.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.table.Domain` + instance or dict with compatible properties header - plotly.graph_objects.table.Header instance or - dict with compatible properties + :class:`plotly.graph_objects.table.Header` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -1727,8 +1730,8 @@ def __init__(self, plotly_name="table", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.table.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.table.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during @@ -1757,8 +1760,8 @@ def __init__(self, plotly_name="table", parent_name="", **kwargs): Sets the trace name. The trace name appear as the legend item and on hover. stream - plotly.graph_objects.table.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.table.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -1846,8 +1849,8 @@ def __init__(self, plotly_name="surface", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.surface.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.surface.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -1866,8 +1869,8 @@ def __init__(self, plotly_name="surface", parent_name="", **kwargs): Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. contours - plotly.graph_objects.surface.Contours instance - or dict with compatible properties + :class:`plotly.graph_objects.surface.Contours` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -1892,8 +1895,8 @@ def __init__(self, plotly_name="surface", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.surface.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.Hoverlabel + ` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -1942,11 +1945,12 @@ def __init__(self, plotly_name="surface", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.surface.Lighting instance - or dict with compatible properties - lightposition - plotly.graph_objects.surface.Lightposition + :class:`plotly.graph_objects.surface.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.surface.Lightposit + ion` instance or dict with compatible + properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -1995,8 +1999,8 @@ def __init__(self, plotly_name="surface", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.surface.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.surface.Stream` + instance or dict with compatible properties surfacecolor Sets the surface color values, used for setting a color scale independent of `z`. @@ -2103,8 +2107,8 @@ def __init__(self, plotly_name="sunburst", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sunburst.Domain instance - or dict with compatible properties + :class:`plotly.graph_objects.sunburst.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -2115,8 +2119,8 @@ def __init__(self, plotly_name="sunburst", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.sunburst.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.Hoverlabe + l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -2187,8 +2191,8 @@ def __init__(self, plotly_name="sunburst", parent_name="", **kwargs): Sets the source reference on plot.ly for labels . leaf - plotly.graph_objects.sunburst.Leaf instance or - dict with compatible properties + :class:`plotly.graph_objects.sunburst.Leaf` + instance or dict with compatible properties level Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from @@ -2196,8 +2200,8 @@ def __init__(self, plotly_name="sunburst", parent_name="", **kwargs): if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`. marker - plotly.graph_objects.sunburst.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.sunburst.Marker` + instance or dict with compatible properties maxdepth Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render @@ -2243,8 +2247,8 @@ def __init__(self, plotly_name="sunburst", parent_name="", **kwargs): Sets the source reference on plot.ly for parents . stream - plotly.graph_objects.sunburst.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.sunburst.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, @@ -2379,8 +2383,8 @@ def __init__(self, plotly_name="streamtube", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.streamtube.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.streamtube.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -2414,8 +2418,9 @@ def __init__(self, plotly_name="streamtube", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.streamtube.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Hoverla + bel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -2463,11 +2468,12 @@ def __init__(self, plotly_name="streamtube", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.streamtube.Lighting - instance or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lightin + g` instance or dict with compatible properties lightposition - plotly.graph_objects.streamtube.Lightposition - instance or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Lightpo + sition` instance or dict with compatible + properties maxdisplayed The maximum number of displayed segments in a streamtube. @@ -2524,11 +2530,11 @@ def __init__(self, plotly_name="streamtube", parent_name="", **kwargs): tubes from touching at adjacent starting positions. starts - plotly.graph_objects.streamtube.Starts instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties stream - plotly.graph_objects.streamtube.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties text Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, @@ -2618,10 +2624,11 @@ def __init__(self, plotly_name="splom", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . diagonal - plotly.graph_objects.splom.Diagonal instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.Diagonal` + instance or dict with compatible properties dimensions - A tuple of plotly.graph_objects.splom.Dimension + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances or dicts with compatible properties dimensiondefaults When used in a template (as @@ -2638,8 +2645,8 @@ def __init__(self, plotly_name="splom", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.splom.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.splom.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -2688,8 +2695,8 @@ def __init__(self, plotly_name="splom", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.splom.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -2713,8 +2720,8 @@ def __init__(self, plotly_name="splom", parent_name="", **kwargs): opacity Sets the opacity of the trace. selected - plotly.graph_objects.splom.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -2734,8 +2741,8 @@ def __init__(self, plotly_name="splom", parent_name="", **kwargs): Determines whether or not subplots on the upper half from the diagonal are displayed. stream - plotly.graph_objects.splom.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.splom.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair to appear on hover. If a single string, @@ -2773,8 +2780,8 @@ def __init__(self, plotly_name="splom", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.splom.Unselected instance - or dict with compatible properties + :class:`plotly.graph_objects.splom.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -2889,8 +2896,9 @@ def __init__(self, plotly_name="scatterternary", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterternary.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Hov + erlabel` instance or dict with compatible + properties hoveron Do the hover effects highlight individual points (markers or line points) or do they @@ -2951,11 +2959,12 @@ def __init__(self, plotly_name="scatterternary", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterternary.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Lin + e` instance or dict with compatible properties marker - plotly.graph_objects.scatterternary.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Mar + ker` instance or dict with compatible + properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -2987,8 +2996,9 @@ def __init__(self, plotly_name="scatterternary", parent_name="", **kwargs): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scatterternary.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Sel + ected` instance or dict with compatible + properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -3002,8 +3012,9 @@ def __init__(self, plotly_name="scatterternary", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterternary.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Str + eam` instance or dict with compatible + properties subplot Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" @@ -3087,8 +3098,9 @@ def __init__(self, plotly_name="scatterternary", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterternary.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.Uns + elected` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -3172,8 +3184,9 @@ def __init__(self, plotly_name="scatterpolargl", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolargl.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Hov + erlabel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -3227,11 +3240,12 @@ def __init__(self, plotly_name="scatterpolargl", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolargl.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Lin + e` instance or dict with compatible properties marker - plotly.graph_objects.scatterpolargl.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Mar + ker` instance or dict with compatible + properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -3271,8 +3285,9 @@ def __init__(self, plotly_name="scatterpolargl", parent_name="", **kwargs): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolargl.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Sel + ected` instance or dict with compatible + properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -3286,8 +3301,9 @@ def __init__(self, plotly_name="scatterpolargl", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolargl.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Str + eam` instance or dict with compatible + properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" @@ -3377,8 +3393,9 @@ def __init__(self, plotly_name="scatterpolargl", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolargl.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.Uns + elected` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -3454,8 +3471,9 @@ def __init__(self, plotly_name="scatterpolar", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatterpolar.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Hover + label` instance or dict with compatible + properties hoveron Do the hover effects highlight individual points (markers or line points) or do they @@ -3516,11 +3534,11 @@ def __init__(self, plotly_name="scatterpolar", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatterpolar.Line instance - or dict with compatible properties - marker - plotly.graph_objects.scatterpolar.Marker + :class:`plotly.graph_objects.scatterpolar.Line` instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolar.Marke + r` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -3560,8 +3578,9 @@ def __init__(self, plotly_name="scatterpolar", parent_name="", **kwargs): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatterpolar.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Selec + ted` instance or dict with compatible + properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -3575,8 +3594,8 @@ def __init__(self, plotly_name="scatterpolar", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatterpolar.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Strea + m` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" @@ -3666,8 +3685,9 @@ def __init__(self, plotly_name="scatterpolar", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatterpolar.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.Unsel + ected` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -3732,8 +3752,9 @@ def __init__(self, plotly_name="scattermapbox", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattermapbox.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Hove + rlabel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -3793,16 +3814,16 @@ def __init__(self, plotly_name="scattermapbox", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattermapbox.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Line + ` instance or dict with compatible properties lon Sets the longitude coordinates (in degrees East). lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattermapbox.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Mark + er` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -3832,8 +3853,9 @@ def __init__(self, plotly_name="scattermapbox", parent_name="", **kwargs): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattermapbox.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Sele + cted` instance or dict with compatible + properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -3847,8 +3869,8 @@ def __init__(self, plotly_name="scattermapbox", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattermapbox.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Stre + am` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" @@ -3925,8 +3947,9 @@ def __init__(self, plotly_name="scattermapbox", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattermapbox.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.Unse + lected` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -3970,11 +3993,11 @@ def __init__(self, plotly_name="scattergl", parent_name="", **kwargs): Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scattergl.ErrorX instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorX` + instance or dict with compatible properties error_y - plotly.graph_objects.scattergl.ErrorY instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergl.ErrorY` + instance or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is @@ -4016,8 +4039,8 @@ def __init__(self, plotly_name="scattergl", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergl.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.Hoverlab + el` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -4071,11 +4094,11 @@ def __init__(self, plotly_name="scattergl", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergl.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scattergl.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scattergl.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergl.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -4102,8 +4125,8 @@ def __init__(self, plotly_name="scattergl", parent_name="", **kwargs): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergl.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.Selected + ` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -4117,8 +4140,8 @@ def __init__(self, plotly_name="scattergl", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergl.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergl.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string @@ -4189,8 +4212,8 @@ def __init__(self, plotly_name="scattergl", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergl.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.Unselect + ed` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -4303,8 +4326,9 @@ def __init__(self, plotly_name="scattergeo", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattergeo.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Hoverla + bel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -4365,8 +4389,8 @@ def __init__(self, plotly_name="scattergeo", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattergeo.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Line` + instance or dict with compatible properties locationmode Determines the set of locations used to match entries in `locations` to regions on the map. @@ -4389,8 +4413,8 @@ def __init__(self, plotly_name="scattergeo", parent_name="", **kwargs): lonsrc Sets the source reference on plot.ly for lon . marker - plotly.graph_objects.scattergeo.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -4422,8 +4446,8 @@ def __init__(self, plotly_name="scattergeo", parent_name="", **kwargs): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattergeo.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Selecte + d` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -4437,8 +4461,8 @@ def __init__(self, plotly_name="scattergeo", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattergeo.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties text Sets text elements associated with each (lon,lat) pair or item in `locations`. If a @@ -4511,8 +4535,9 @@ def __init__(self, plotly_name="scattergeo", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattergeo.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.Unselec + ted` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -4588,8 +4613,9 @@ def __init__(self, plotly_name="scattercarpet", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scattercarpet.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Hove + rlabel` instance or dict with compatible + properties hoveron Do the hover effects highlight individual points (markers or line points) or do they @@ -4650,11 +4676,11 @@ def __init__(self, plotly_name="scattercarpet", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scattercarpet.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Line + ` instance or dict with compatible properties marker - plotly.graph_objects.scattercarpet.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Mark + er` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -4686,8 +4712,9 @@ def __init__(self, plotly_name="scattercarpet", parent_name="", **kwargs): opacity Sets the opacity of the trace. selected - plotly.graph_objects.scattercarpet.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Sele + cted` instance or dict with compatible + properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -4701,8 +4728,8 @@ def __init__(self, plotly_name="scattercarpet", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scattercarpet.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Stre + am` instance or dict with compatible properties text Sets text elements associated with each (a,b) point. If a single string, the same string @@ -4773,8 +4800,9 @@ def __init__(self, plotly_name="scattercarpet", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scattercarpet.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.Unse + lected` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -4824,14 +4852,14 @@ def __init__(self, plotly_name="scatter3d", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.scatter3d.ErrorX instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorX` + instance or dict with compatible properties error_y - plotly.graph_objects.scatter3d.ErrorY instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorY` + instance or dict with compatible properties error_z - plotly.graph_objects.scatter3d.ErrorZ instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.ErrorZ` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -4842,8 +4870,8 @@ def __init__(self, plotly_name="scatter3d", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter3d.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Hoverlab + el` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -4897,11 +4925,11 @@ def __init__(self, plotly_name="scatter3d", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter3d.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatter3d.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -4933,8 +4961,8 @@ def __init__(self, plotly_name="scatter3d", parent_name="", **kwargs): opacity Sets the opacity of the trace. projection - plotly.graph_objects.scatter3d.Projection - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Projecti + on` instance or dict with compatible properties scene Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" @@ -4946,8 +4974,8 @@ def __init__(self, plotly_name="scatter3d", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.scatter3d.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Stream` + instance or dict with compatible properties surfaceaxis If "-1", the scatter points are not fill with a surface If 0, 1, 2, the scatter points are @@ -4965,8 +4993,8 @@ def __init__(self, plotly_name="scatter3d", parent_name="", **kwargs): "hovertext" is not set, these elements will be seen in the hover labels. textfont - plotly.graph_objects.scatter3d.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.Textfont + ` instance or dict with compatible properties textposition Sets the positions of the `text` elements with respects to the (x,y) coordinates. @@ -5095,11 +5123,11 @@ def __init__(self, plotly_name="scatter", parent_name="", **kwargs): Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.scatter.ErrorX instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.ErrorX` + instance or dict with compatible properties error_y - plotly.graph_objects.scatter.ErrorY instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.ErrorY` + instance or dict with compatible properties fill Sets the area to fill with a solid color. Defaults to "none" unless this trace is @@ -5155,8 +5183,8 @@ def __init__(self, plotly_name="scatter", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.scatter.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.Hoverlabel + ` instance or dict with compatible properties hoveron Do the hover effects highlight individual points (markers or line points) or do they @@ -5217,11 +5245,11 @@ def __init__(self, plotly_name="scatter", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.scatter.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Line` + instance or dict with compatible properties marker - plotly.graph_objects.scatter.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -5269,8 +5297,8 @@ def __init__(self, plotly_name="scatter", parent_name="", **kwargs): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.scatter.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.scatter.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -5313,8 +5341,8 @@ def __init__(self, plotly_name="scatter", parent_name="", **kwargs): consecutive, the later ones will be pushed down in the drawing order. stream - plotly.graph_objects.scatter.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.scatter.Stream` + instance or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" @@ -5392,8 +5420,8 @@ def __init__(self, plotly_name="scatter", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.scatter.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.Unselected + ` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -5471,8 +5499,8 @@ def __init__(self, plotly_name="sankey", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . domain - plotly.graph_objects.sankey.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.sankey.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -5482,8 +5510,8 @@ def __init__(self, plotly_name="sankey", parent_name="", **kwargs): by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively. hoverlabel - plotly.graph_objects.sankey.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during @@ -5527,8 +5555,8 @@ def __init__(self, plotly_name="sankey", parent_name="", **kwargs): where the `selected` and `unselected` styles have no effect. stream - plotly.graph_objects.sankey.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.sankey.Stream` + instance or dict with compatible properties textfont Sets the font for node labels uid @@ -5609,8 +5637,9 @@ def __init__(self, plotly_name="pointcloud", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pointcloud.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Hoverla + bel` instance or dict with compatible + properties ids Assigns id labels to each datum. These ids for object constancy of data points during @@ -5637,8 +5666,8 @@ def __init__(self, plotly_name="pointcloud", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pointcloud.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -5665,8 +5694,8 @@ def __init__(self, plotly_name="pointcloud", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.pointcloud.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string @@ -5791,8 +5820,8 @@ def __init__(self, plotly_name="pie", parent_name="", **kwargs): Sets the label step. See `label0` for more info. domain - plotly.graph_objects.pie.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.pie.Domain` + instance or dict with compatible properties hole Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart. @@ -5806,8 +5835,8 @@ def __init__(self, plotly_name="pie", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.pie.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.pie.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -5890,8 +5919,8 @@ def __init__(self, plotly_name="pie", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.pie.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.pie.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -5941,8 +5970,8 @@ def __init__(self, plotly_name="pie", parent_name="", **kwargs): Determines whether or not the sectors are reordered from largest to smallest. stream - plotly.graph_objects.pie.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.pie.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, @@ -5988,8 +6017,8 @@ def __init__(self, plotly_name="pie", parent_name="", **kwargs): Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.pie.Title instance or dict - with compatible properties + :class:`plotly.graph_objects.pie.Title` + instance or dict with compatible properties titlefont Deprecated: Please use pie.title.font instead. Sets the font used for `title`. Note that the @@ -6075,8 +6104,8 @@ def __init__(self, plotly_name="parcoords", parent_name="", **kwargs): default property values to use for elements of parcoords.dimensions domain - plotly.graph_objects.parcoords.Domain instance - or dict with compatible properties + :class:`plotly.graph_objects.parcoords.Domain` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during @@ -6101,8 +6130,8 @@ def __init__(self, plotly_name="parcoords", parent_name="", **kwargs): positioned better inside margins when `labelposition` is set to "bottom". line - plotly.graph_objects.parcoords.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.parcoords.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -6126,8 +6155,8 @@ def __init__(self, plotly_name="parcoords", parent_name="", **kwargs): rangefont Sets the font for the `dimension` range values. stream - plotly.graph_objects.parcoords.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.parcoords.Stream` + instance or dict with compatible properties tickfont Sets the font for the `dimension` tick values. uid @@ -6206,8 +6235,8 @@ def __init__(self, plotly_name="parcats", parent_name="", **kwargs): property values to use for elements of parcats.dimensions domain - plotly.graph_objects.parcats.Domain instance or - dict with compatible properties + :class:`plotly.graph_objects.parcats.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -6254,8 +6283,8 @@ def __init__(self, plotly_name="parcats", parent_name="", **kwargs): labelfont Sets the font for the `dimension` labels. line - plotly.graph_objects.parcats.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.parcats.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -6282,8 +6311,8 @@ def __init__(self, plotly_name="parcats", parent_name="", **kwargs): left to right. If `backward`, sort paths based on dimensions categories from right to left. stream - plotly.graph_objects.parcats.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.parcats.Stream` + instance or dict with compatible properties tickfont Sets the font for the `category` labels. uid @@ -6350,8 +6379,8 @@ def __init__(self, plotly_name="ohlc", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.ohlc.Decreasing instance - or dict with compatible properties + :class:`plotly.graph_objects.ohlc.Decreasing` + instance or dict with compatible properties high Sets the high values. highsrc @@ -6367,8 +6396,8 @@ def __init__(self, plotly_name="ohlc", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.ohlc.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.ohlc.Hoverlabel` + instance or dict with compatible properties hovertext Same as `text`. hovertextsrc @@ -6382,15 +6411,15 @@ def __init__(self, plotly_name="ohlc", parent_name="", **kwargs): idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.ohlc.Increasing instance - or dict with compatible properties + :class:`plotly.graph_objects.ohlc.Increasing` + instance or dict with compatible properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.ohlc.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.ohlc.Line` + instance or dict with compatible properties low Sets the low values. lowsrc @@ -6435,8 +6464,8 @@ def __init__(self, plotly_name="ohlc", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.ohlc.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.ohlc.Stream` + instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same @@ -6580,8 +6609,8 @@ def __init__(self, plotly_name="mesh3d", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.mesh3d.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.mesh3d.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -6597,8 +6626,8 @@ def __init__(self, plotly_name="mesh3d", parent_name="", **kwargs): Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth ,Electric,Viridis,Cividis. contour - plotly.graph_objects.mesh3d.Contour instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Contour` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -6634,8 +6663,8 @@ def __init__(self, plotly_name="mesh3d", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.mesh3d.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -6730,11 +6759,11 @@ def __init__(self, plotly_name="mesh3d", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.mesh3d.Lighting instance - or dict with compatible properties - lightposition - plotly.graph_objects.mesh3d.Lightposition + :class:`plotly.graph_objects.mesh3d.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.mesh3d.Lightpositi + on` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -6783,8 +6812,8 @@ def __init__(self, plotly_name="mesh3d", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.mesh3d.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.mesh3d.Stream` + instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a @@ -6891,8 +6920,8 @@ def __init__(self, plotly_name="isosurface", parent_name="", **kwargs): according to whether numbers in the `color` array are all positive, all negative or mixed. caps - plotly.graph_objects.isosurface.Caps instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Caps` + instance or dict with compatible properties cauto Determines whether or not the color domain is computed with respect to the input data (here @@ -6923,8 +6952,8 @@ def __init__(self, plotly_name="isosurface", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.isosurface.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -6940,8 +6969,8 @@ def __init__(self, plotly_name="isosurface", parent_name="", **kwargs): Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth ,Electric,Viridis,Cividis. contour - plotly.graph_objects.isosurface.Contour - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Contour + ` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -6965,8 +6994,9 @@ def __init__(self, plotly_name="isosurface", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.isosurface.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Hoverla + bel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -7019,11 +7049,12 @@ def __init__(self, plotly_name="isosurface", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.isosurface.Lighting - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lightin + g` instance or dict with compatible properties lightposition - plotly.graph_objects.isosurface.Lightposition - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.Lightpo + sition` instance or dict with compatible + properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -7072,17 +7103,18 @@ def __init__(self, plotly_name="isosurface", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. slices - plotly.graph_objects.isosurface.Slices instance - or dict with compatible properties - spaceframe - plotly.graph_objects.isosurface.Spaceframe + :class:`plotly.graph_objects.isosurface.Slices` instance or dict with compatible properties + spaceframe + :class:`plotly.graph_objects.isosurface.Spacefr + ame` instance or dict with compatible + properties stream - plotly.graph_objects.isosurface.Stream instance - or dict with compatible properties - surface - plotly.graph_objects.isosurface.Surface + :class:`plotly.graph_objects.isosurface.Stream` instance or dict with compatible properties + surface + :class:`plotly.graph_objects.isosurface.Surface + ` instance or dict with compatible properties text Sets the text elements associated with the vertices. If trace `hoverinfo` contains a @@ -7175,11 +7207,11 @@ def __init__(self, plotly_name="indicator", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . delta - plotly.graph_objects.indicator.Delta instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.Delta` + instance or dict with compatible properties domain - plotly.graph_objects.indicator.Domain instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.Domain` + instance or dict with compatible properties gauge The gauge of the Indicator plot. ids @@ -7216,14 +7248,14 @@ def __init__(self, plotly_name="indicator", parent_name="", **kwargs): Sets the trace name. The trace name appear as the legend item and on hover. number - plotly.graph_objects.indicator.Number instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.Number` + instance or dict with compatible properties stream - plotly.graph_objects.indicator.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.Stream` + instance or dict with compatible properties title - plotly.graph_objects.indicator.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.indicator.Title` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -7301,8 +7333,8 @@ def __init__(self, plotly_name="image", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.image.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.image.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -7370,8 +7402,8 @@ def __init__(self, plotly_name="image", parent_name="", **kwargs): opacity Sets the opacity of the trace. stream - plotly.graph_objects.image.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.image.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. @@ -7507,8 +7539,9 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2dcontour.ColorBa - r instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -7524,8 +7557,9 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth ,Electric,Viridis,Cividis. contours - plotly.graph_objects.histogram2dcontour.Contour - s instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .Contours` instance or dict with compatible + properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -7572,8 +7606,9 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2dcontour.Hoverla - bel instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .Hoverlabel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -7617,11 +7652,13 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.histogram2dcontour.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .Line` instance or dict with compatible + properties marker - plotly.graph_objects.histogram2dcontour.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .Marker` instance or dict with compatible + properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -7675,8 +7712,9 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2dcontour.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .Stream` instance or dict with compatible + properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -7726,8 +7764,9 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2dcontour.XBins - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .XBins` instance or dict with compatible + properties xcalendar Sets the calendar system to use with `x` date data. @@ -7751,8 +7790,9 @@ def __init__(self, plotly_name="histogram2dcontour", parent_name="", **kwargs): value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2dcontour.YBins - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2dcontour + .YBins` instance or dict with compatible + properties ycalendar Sets the calendar system to use with `y` date data. @@ -7841,8 +7881,8 @@ def __init__(self, plotly_name="histogram2d", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram2d.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.ColorB + ar` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -7903,8 +7943,9 @@ def __init__(self, plotly_name="histogram2d", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram2d.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Hoverl + abel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -7948,8 +7989,8 @@ def __init__(self, plotly_name="histogram2d", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram2d.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Marker + ` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -7996,8 +8037,8 @@ def __init__(self, plotly_name="histogram2d", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.histogram2d.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.Stream + ` instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -8047,8 +8088,8 @@ def __init__(self, plotly_name="histogram2d", parent_name="", **kwargs): value can be used to set (1D) histogram `bingroup` xbins - plotly.graph_objects.histogram2d.XBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. @@ -8075,8 +8116,8 @@ def __init__(self, plotly_name="histogram2d", parent_name="", **kwargs): value can be used to set (1D) histogram `bingroup` ybins - plotly.graph_objects.histogram2d.YBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. @@ -8166,8 +8207,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): settings. Note that histogram and histogram2d* trace can share the same `bingroup` cumulative - plotly.graph_objects.histogram.Cumulative - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.Cumulati + ve` instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -8178,11 +8219,11 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . error_x - plotly.graph_objects.histogram.ErrorX instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.ErrorX` + instance or dict with compatible properties error_y - plotly.graph_objects.histogram.ErrorY instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.ErrorY` + instance or dict with compatible properties histfunc Specifies the binning function used for this histogram trace. If "count", the histogram @@ -8220,8 +8261,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.histogram.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.Hoverlab + el` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -8270,8 +8311,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.histogram.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -8316,8 +8357,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): ("h"), the value of the each bar spans along the vertical (horizontal). selected - plotly.graph_objects.histogram.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.Selected + ` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -8331,8 +8372,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.histogram.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.Stream` + instance or dict with compatible properties text Sets hover text elements associated with each bar. If a single string, the same string @@ -8369,8 +8410,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.histogram.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.Unselect + ed` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -8386,8 +8427,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. xbins - plotly.graph_objects.histogram.XBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.XBins` + instance or dict with compatible properties xcalendar Sets the calendar system to use with `x` date data. @@ -8403,8 +8444,8 @@ def __init__(self, plotly_name="histogram", parent_name="", **kwargs): `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. ybins - plotly.graph_objects.histogram.YBins instance - or dict with compatible properties + :class:`plotly.graph_objects.histogram.YBins` + instance or dict with compatible properties ycalendar Sets the calendar system to use with `y` date data. @@ -8446,8 +8487,8 @@ def __init__(self, plotly_name="heatmapgl", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmapgl.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.ColorBar + ` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -8487,8 +8528,8 @@ def __init__(self, plotly_name="heatmapgl", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmapgl.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.Hoverlab + el` instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during @@ -8527,8 +8568,8 @@ def __init__(self, plotly_name="heatmapgl", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmapgl.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. @@ -8668,8 +8709,8 @@ def __init__(self, plotly_name="heatmap", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.heatmap.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.heatmap.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -8715,8 +8756,8 @@ def __init__(self, plotly_name="heatmap", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.heatmap.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmap.Hoverlabel + ` instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover @@ -8802,8 +8843,8 @@ def __init__(self, plotly_name="heatmap", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.heatmap.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.heatmap.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. @@ -8964,8 +9005,8 @@ def __init__(self, plotly_name="funnelarea", parent_name="", **kwargs): Sets the label step. See `label0` for more info. domain - plotly.graph_objects.funnelarea.Domain instance - or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -8976,8 +9017,9 @@ def __init__(self, plotly_name="funnelarea", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnelarea.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Hoverla + bel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -9049,8 +9091,8 @@ def __init__(self, plotly_name="funnelarea", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnelarea.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -9082,8 +9124,8 @@ def __init__(self, plotly_name="funnelarea", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnelarea.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties text Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, @@ -9129,8 +9171,8 @@ def __init__(self, plotly_name="funnelarea", parent_name="", **kwargs): Sets the source reference on plot.ly for texttemplate . title - plotly.graph_objects.funnelarea.Title instance - or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.Title` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -9199,8 +9241,8 @@ def __init__(self, plotly_name="funnel", parent_name="", **kwargs): set `xaxis.layer` and `yaxis.layer` to *below traces*. connector - plotly.graph_objects.funnel.Connector instance - or dict with compatible properties + :class:`plotly.graph_objects.funnel.Connector` + instance or dict with compatible properties constraintext Constrain the size of text inside or outside a bar to be no larger than the bar itself. @@ -9229,8 +9271,8 @@ def __init__(self, plotly_name="funnel", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.funnel.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -9292,8 +9334,8 @@ def __init__(self, plotly_name="funnel", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.funnel.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -9351,8 +9393,8 @@ def __init__(self, plotly_name="funnel", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.funnel.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.funnel.Stream` + instance or dict with compatible properties text Sets text elements associated with each (x,y) pair. If a single string, the same string @@ -9521,8 +9563,9 @@ def __init__(self, plotly_name="densitymapbox", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.densitymapbox.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Colo + rBar` instance or dict with compatible + properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -9556,8 +9599,9 @@ def __init__(self, plotly_name="densitymapbox", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.densitymapbox.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Hove + rlabel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -9663,8 +9707,8 @@ def __init__(self, plotly_name="densitymapbox", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.densitymapbox.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.Stre + am` instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" @@ -9813,8 +9857,9 @@ def __init__(self, plotly_name="contourcarpet", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contourcarpet.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Colo + rBar` instance or dict with compatible + properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -9830,8 +9875,9 @@ def __init__(self, plotly_name="contourcarpet", parent_name="", **kwargs): Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth ,Electric,Viridis,Cividis. contours - plotly.graph_objects.contourcarpet.Contours - instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Cont + ours` instance or dict with compatible + properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -9869,8 +9915,8 @@ def __init__(self, plotly_name="contourcarpet", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contourcarpet.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Line + ` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -9912,8 +9958,8 @@ def __init__(self, plotly_name="contourcarpet", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contourcarpet.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.Stre + am` instance or dict with compatible properties text Sets the text elements associated with each z value. @@ -10031,8 +10077,8 @@ def __init__(self, plotly_name="contour", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.contour.ColorBar instance - or dict with compatible properties + :class:`plotly.graph_objects.contour.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -10054,8 +10100,8 @@ def __init__(self, plotly_name="contour", parent_name="", **kwargs): dimensional array otherwise it is defaulted to false. contours - plotly.graph_objects.contour.Contours instance - or dict with compatible properties + :class:`plotly.graph_objects.contour.Contours` + instance or dict with compatible properties customdata Assigns extra data each datum. This may be useful when listening to hover, click and @@ -10086,8 +10132,8 @@ def __init__(self, plotly_name="contour", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.contour.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.contour.Hoverlabel + ` instance or dict with compatible properties hoverongaps Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover @@ -10140,8 +10186,8 @@ def __init__(self, plotly_name="contour", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.contour.Line instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.Line` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -10183,8 +10229,8 @@ def __init__(self, plotly_name="contour", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.contour.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.contour.Stream` + instance or dict with compatible properties text Sets the text elements associated with each z value. @@ -10361,8 +10407,8 @@ def __init__(self, plotly_name="cone", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.cone.ColorBar instance or - dict with compatible properties + :class:`plotly.graph_objects.cone.ColorBar` + instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -10396,8 +10442,8 @@ def __init__(self, plotly_name="cone", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.cone.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.cone.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -10446,11 +10492,11 @@ def __init__(self, plotly_name="cone", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. lighting - plotly.graph_objects.cone.Lighting instance or - dict with compatible properties - lightposition - plotly.graph_objects.cone.Lightposition + :class:`plotly.graph_objects.cone.Lighting` instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition + ` instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -10520,8 +10566,8 @@ def __init__(self, plotly_name="cone", parent_name="", **kwargs): default value is half the sample's maximum vector norm. stream - plotly.graph_objects.cone.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.cone.Stream` + instance or dict with compatible properties text Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" @@ -10631,8 +10677,9 @@ def __init__(self, plotly_name="choroplethmapbox", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choroplethmapbox.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -10678,8 +10725,9 @@ def __init__(self, plotly_name="choroplethmapbox", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choroplethmapbox.Hoverlabe - l instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.H + overlabel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -10734,8 +10782,9 @@ def __init__(self, plotly_name="choroplethmapbox", parent_name="", **kwargs): Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choroplethmapbox.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.M + arker` instance or dict with compatible + properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -10762,8 +10811,9 @@ def __init__(self, plotly_name="choroplethmapbox", parent_name="", **kwargs): array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choroplethmapbox.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.S + elected` instance or dict with compatible + properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -10780,8 +10830,9 @@ def __init__(self, plotly_name="choroplethmapbox", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choroplethmapbox.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.S + tream` instance or dict with compatible + properties subplot Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" @@ -10821,8 +10872,9 @@ def __init__(self, plotly_name="choroplethmapbox", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choroplethmapbox.Unselecte - d instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.U + nselected` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -10888,8 +10940,8 @@ def __init__(self, plotly_name="choropleth", parent_name="", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.choropleth.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -10944,8 +10996,9 @@ def __init__(self, plotly_name="choropleth", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.choropleth.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.Hoverla + bel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -11008,8 +11061,8 @@ def __init__(self, plotly_name="choropleth", parent_name="", **kwargs): Sets the source reference on plot.ly for locations . marker - plotly.graph_objects.choropleth.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -11036,8 +11089,8 @@ def __init__(self, plotly_name="choropleth", parent_name="", **kwargs): array and `zmax` will correspond to the first color. selected - plotly.graph_objects.choropleth.Selected - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.Selecte + d` instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -11054,8 +11107,8 @@ def __init__(self, plotly_name="choropleth", parent_name="", **kwargs): Determines whether or not a colorbar is displayed for this trace. stream - plotly.graph_objects.choropleth.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties text Sets the text elements associated with each location. @@ -11089,8 +11142,9 @@ def __init__(self, plotly_name="choropleth", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.choropleth.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.Unselec + ted` instance or dict with compatible + properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -11146,8 +11200,8 @@ def __init__(self, plotly_name="carpet", parent_name="", **kwargs): coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step. aaxis - plotly.graph_objects.carpet.Aaxis instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.Aaxis` + instance or dict with compatible properties asrc Sets the source reference on plot.ly for a . b @@ -11158,8 +11212,8 @@ def __init__(self, plotly_name="carpet", parent_name="", **kwargs): coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step. baxis - plotly.graph_objects.carpet.Baxis instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.Baxis` + instance or dict with compatible properties bsrc Sets the source reference on plot.ly for b . carpet @@ -11224,8 +11278,8 @@ def __init__(self, plotly_name="carpet", parent_name="", **kwargs): opacity Sets the opacity of the trace. stream - plotly.graph_objects.carpet.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.carpet.Stream` + instance or dict with compatible properties uid Assign an id to this trace, Use this to provide object constancy between traces during @@ -11314,8 +11368,9 @@ def __init__(self, plotly_name="candlestick", parent_name="", **kwargs): Sets the source reference on plot.ly for customdata . decreasing - plotly.graph_objects.candlestick.Decreasing - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.Decrea + sing` instance or dict with compatible + properties high Sets the high values. highsrc @@ -11331,8 +11386,9 @@ def __init__(self, plotly_name="candlestick", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.candlestick.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.Hoverl + abel` instance or dict with compatible + properties hovertext Same as `text`. hovertextsrc @@ -11346,15 +11402,16 @@ def __init__(self, plotly_name="candlestick", parent_name="", **kwargs): idssrc Sets the source reference on plot.ly for ids . increasing - plotly.graph_objects.candlestick.Increasing - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.Increa + sing` instance or dict with compatible + properties legendgroup Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.candlestick.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.candlestick.Line` + instance or dict with compatible properties low Sets the low values. lowsrc @@ -11399,8 +11456,8 @@ def __init__(self, plotly_name="candlestick", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.candlestick.Stream - instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.Stream + ` instance or dict with compatible properties text Sets hover text elements associated with each sample point. If a single string, the same @@ -11539,8 +11596,8 @@ def __init__(self, plotly_name="box", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.box.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.box.Hoverlabel` + instance or dict with compatible properties hoveron Do the hover effects highlight individual boxes or sample points or both? @@ -11598,8 +11655,8 @@ def __init__(self, plotly_name="box", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. line - plotly.graph_objects.box.Line instance or dict - with compatible properties + :class:`plotly.graph_objects.box.Line` instance + or dict with compatible properties lowerfence Sets the lower fence values. There should be as many items as the number of boxes desired. This @@ -11612,8 +11669,8 @@ def __init__(self, plotly_name="box", parent_name="", **kwargs): Sets the source reference on plot.ly for lowerfence . marker - plotly.graph_objects.box.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.box.Marker` + instance or dict with compatible properties mean Sets the mean values. There should be as many items as the number of boxes desired. This @@ -11738,8 +11795,8 @@ def __init__(self, plotly_name="box", parent_name="", **kwargs): sdsrc Sets the source reference on plot.ly for sd . selected - plotly.graph_objects.box.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.box.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -11753,8 +11810,8 @@ def __init__(self, plotly_name="box", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.box.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.box.Stream` + instance or dict with compatible properties text Sets the text elements associated with each sample value. If a single string, the same @@ -11793,8 +11850,8 @@ def __init__(self, plotly_name="box", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.box.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.box.Unselected` + instance or dict with compatible properties upperfence Sets the upper fence values. There should be as many items as the number of boxes desired. This @@ -11909,8 +11966,8 @@ def __init__(self, plotly_name="barpolar", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.barpolar.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.Hoverlabe + l` instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -11959,8 +12016,8 @@ def __init__(self, plotly_name="barpolar", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.barpolar.Marker instance - or dict with compatible properties + :class:`plotly.graph_objects.barpolar.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -11998,8 +12055,8 @@ def __init__(self, plotly_name="barpolar", parent_name="", **kwargs): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.barpolar.Selected instance - or dict with compatible properties + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -12013,8 +12070,8 @@ def __init__(self, plotly_name="barpolar", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.barpolar.Stream instance - or dict with compatible properties + :class:`plotly.graph_objects.barpolar.Stream` + instance or dict with compatible properties subplot Sets a reference between this trace's data coordinates and a polar subplot. If "polar" @@ -12070,8 +12127,8 @@ def __init__(self, plotly_name="barpolar", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.barpolar.Unselected - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.Unselecte + d` instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -12140,11 +12197,11 @@ def __init__(self, plotly_name="bar", parent_name="", **kwargs): Sets the y coordinate step. See `y0` for more info. error_x - plotly.graph_objects.bar.ErrorX instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.ErrorX` + instance or dict with compatible properties error_y - plotly.graph_objects.bar.ErrorY instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.ErrorY` + instance or dict with compatible properties hoverinfo Determines which trace information appear on hover. If `none` or `skip` are set, no @@ -12155,8 +12212,8 @@ def __init__(self, plotly_name="bar", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.bar.Hoverlabel instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.Hoverlabel` + instance or dict with compatible properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -12218,8 +12275,8 @@ def __init__(self, plotly_name="bar", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.bar.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -12270,8 +12327,8 @@ def __init__(self, plotly_name="bar", parent_name="", **kwargs): rsrc Sets the source reference on plot.ly for r . selected - plotly.graph_objects.bar.Selected instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.Selected` + instance or dict with compatible properties selectedpoints Array containing integer indices of selected points. Has an effect only for traces that @@ -12285,8 +12342,8 @@ def __init__(self, plotly_name="bar", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.bar.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.Stream` + instance or dict with compatible properties t t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" @@ -12378,8 +12435,8 @@ def __init__(self, plotly_name="bar", parent_name="", **kwargs): driven changes if you give each trace a `uid` that stays with it as it moves. unselected - plotly.graph_objects.bar.Unselected instance or - dict with compatible properties + :class:`plotly.graph_objects.bar.Unselected` + instance or dict with compatible properties visible Determines whether or not this trace is visible. If "legendonly", the trace is not @@ -12461,8 +12518,8 @@ def __init__(self, plotly_name="area", parent_name="", **kwargs): Sets the source reference on plot.ly for hoverinfo . hoverlabel - plotly.graph_objects.area.Hoverlabel instance - or dict with compatible properties + :class:`plotly.graph_objects.area.Hoverlabel` + instance or dict with compatible properties ids Assigns id labels to each datum. These ids for object constancy of data points during @@ -12475,8 +12532,8 @@ def __init__(self, plotly_name="area", parent_name="", **kwargs): part of the same legend group hide/show at the same time when toggling legend items. marker - plotly.graph_objects.area.Marker instance or - dict with compatible properties + :class:`plotly.graph_objects.area.Marker` + instance or dict with compatible properties meta Assigns extra meta information associated with this trace that can be used in various text @@ -12509,8 +12566,8 @@ def __init__(self, plotly_name="area", parent_name="", **kwargs): Determines whether or not an item corresponding to this trace is shown in the legend. stream - plotly.graph_objects.area.Stream instance or - dict with compatible properties + :class:`plotly.graph_objects.area.Stream` + instance or dict with compatible properties t Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular diff --git a/packages/python/plotly/plotly/validators/bar/__init__.py b/packages/python/plotly/plotly/validators/bar/__init__.py index 527d9c7e892..fa268a12e5c 100644 --- a/packages/python/plotly/plotly/validators/bar/__init__.py +++ b/packages/python/plotly/plotly/validators/bar/__init__.py @@ -244,11 +244,13 @@ def __init__(self, plotly_name="unselected", parent_name="bar", **kwargs): "data_docs", """ marker - plotly.graph_objects.bar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Mar + ker` instance or dict with compatible + properties textfont - plotly.graph_objects.bar.unselected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.unselected.Tex + tfont` instance or dict with compatible + properties """, ), **kwargs @@ -529,11 +531,12 @@ def __init__(self, plotly_name="selected", parent_name="bar", **kwargs): "data_docs", """ marker - plotly.graph_objects.bar.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Marke + r` instance or dict with compatible properties textfont - plotly.graph_objects.bar.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.selected.Textf + ont` instance or dict with compatible + properties """, ), **kwargs @@ -798,8 +801,8 @@ def __init__(self, plotly_name="marker", parent_name="bar", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.bar.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.ColorBa + r` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -820,8 +823,8 @@ def __init__(self, plotly_name="marker", parent_name="bar", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.bar.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.Line` + instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc diff --git a/packages/python/plotly/plotly/validators/bar/marker/__init__.py b/packages/python/plotly/plotly/validators/bar/marker/__init__.py index 157643597c2..24a565f2af5 100644 --- a/packages/python/plotly/plotly/validators/bar/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/bar/marker/__init__.py @@ -330,9 +330,9 @@ def __init__(self, plotly_name="colorbar", parent_name="bar.marker", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.bar.marker.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.bar.mar + ker.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.bar.marker.colorbar.tickformatstopdefaults), @@ -378,8 +378,9 @@ def __init__(self, plotly_name="colorbar", parent_name="bar.marker", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.bar.marker.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.bar.marker.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use bar.marker.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/barpolar/__init__.py b/packages/python/plotly/plotly/validators/barpolar/__init__.py index 5ff9f2d639c..3a787f08d0e 100644 --- a/packages/python/plotly/plotly/validators/barpolar/__init__.py +++ b/packages/python/plotly/plotly/validators/barpolar/__init__.py @@ -56,11 +56,13 @@ def __init__(self, plotly_name="unselected", parent_name="barpolar", **kwargs): "data_docs", """ marker - plotly.graph_objects.barpolar.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselecte + d.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.barpolar.unselected.Textfo - nt instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.unselecte + d.Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -264,11 +266,13 @@ def __init__(self, plotly_name="selected", parent_name="barpolar", **kwargs): "data_docs", """ marker - plotly.graph_objects.barpolar.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.selected. + Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.barpolar.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.selected. + Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -471,8 +475,9 @@ def __init__(self, plotly_name="marker", parent_name="barpolar", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.barpolar.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.Co + lorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -493,8 +498,8 @@ def __init__(self, plotly_name="marker", parent_name="barpolar", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.barpolar.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.barpolar.marker.Li + ne` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc diff --git a/packages/python/plotly/plotly/validators/barpolar/marker/__init__.py b/packages/python/plotly/plotly/validators/barpolar/marker/__init__.py index eb122286508..a0408bbc464 100644 --- a/packages/python/plotly/plotly/validators/barpolar/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/barpolar/marker/__init__.py @@ -338,9 +338,9 @@ def __init__(self, plotly_name="colorbar", parent_name="barpolar.marker", **kwar tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.barpolar.marker - .colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.barpola + r.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.barpolar.marker.colorbar.tickformatstopdefaul @@ -387,8 +387,8 @@ def __init__(self, plotly_name="colorbar", parent_name="barpolar.marker", **kwar tickwidth Sets the tick width (in px). title - plotly.graph_objects.barpolar.marker.colorbar.T - itle instance or dict with compatible + :class:`plotly.graph_objects.barpolar.marker.co + lorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/box/__init__.py b/packages/python/plotly/plotly/validators/box/__init__.py index 84de090b28b..f483b214a71 100644 --- a/packages/python/plotly/plotly/validators/box/__init__.py +++ b/packages/python/plotly/plotly/validators/box/__init__.py @@ -269,8 +269,9 @@ def __init__(self, plotly_name="unselected", parent_name="box", **kwargs): "data_docs", """ marker - plotly.graph_objects.box.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.box.unselected.Mar + ker` instance or dict with compatible + properties """, ), **kwargs @@ -402,8 +403,8 @@ def __init__(self, plotly_name="selected", parent_name="box", **kwargs): "data_docs", """ marker - plotly.graph_objects.box.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.box.selected.Marke + r` instance or dict with compatible properties """, ), **kwargs @@ -746,8 +747,8 @@ def __init__(self, plotly_name="marker", parent_name="box", **kwargs): and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.box.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.box.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. outliercolor diff --git a/packages/python/plotly/plotly/validators/candlestick/__init__.py b/packages/python/plotly/plotly/validators/candlestick/__init__.py index f79814e988e..2ddd9d88061 100644 --- a/packages/python/plotly/plotly/validators/candlestick/__init__.py +++ b/packages/python/plotly/plotly/validators/candlestick/__init__.py @@ -407,8 +407,9 @@ def __init__(self, plotly_name="increasing", parent_name="candlestick", **kwargs color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.increasing.Lin - e instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.increa + sing.Line` instance or dict with compatible + properties """, ), **kwargs @@ -605,8 +606,9 @@ def __init__(self, plotly_name="decreasing", parent_name="candlestick", **kwargs color, or marker line color, whichever is available. line - plotly.graph_objects.candlestick.decreasing.Lin - e instance or dict with compatible properties + :class:`plotly.graph_objects.candlestick.decrea + sing.Line` instance or dict with compatible + properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/carpet/__init__.py b/packages/python/plotly/plotly/validators/carpet/__init__.py index f4f44deebb0..6f978dc27ed 100644 --- a/packages/python/plotly/plotly/validators/carpet/__init__.py +++ b/packages/python/plotly/plotly/validators/carpet/__init__.py @@ -567,9 +567,9 @@ def __init__(self, plotly_name="baxis", parent_name="carpet", **kwargs): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.carpet.baxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.carpet. + baxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.carpet.baxis.tickformatstopdefaults), sets @@ -597,8 +597,8 @@ def __init__(self, plotly_name="baxis", parent_name="carpet", **kwargs): Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.baxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.carpet.baxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use carpet.baxis.title.font instead. Sets this axis' title font. Note that @@ -838,9 +838,9 @@ def __init__(self, plotly_name="aaxis", parent_name="carpet", **kwargs): 09:15:23.456* with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.carpet.aaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.carpet. + aaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.carpet.aaxis.tickformatstopdefaults), sets @@ -868,8 +868,8 @@ def __init__(self, plotly_name="aaxis", parent_name="carpet", **kwargs): Sets the source reference on plot.ly for tickvals . title - plotly.graph_objects.carpet.aaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.carpet.aaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use carpet.aaxis.title.font instead. Sets this axis' title font. Note that diff --git a/packages/python/plotly/plotly/validators/choropleth/__init__.py b/packages/python/plotly/plotly/validators/choropleth/__init__.py index e9674c632ca..4f5cc22bfe9 100644 --- a/packages/python/plotly/plotly/validators/choropleth/__init__.py +++ b/packages/python/plotly/plotly/validators/choropleth/__init__.py @@ -114,8 +114,9 @@ def __init__(self, plotly_name="unselected", parent_name="choropleth", **kwargs) "data_docs", """ marker - plotly.graph_objects.choropleth.unselected.Mark - er instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.unselec + ted.Marker` instance or dict with compatible + properties """, ), **kwargs @@ -263,8 +264,9 @@ def __init__(self, plotly_name="selected", parent_name="choropleth", **kwargs): "data_docs", """ marker - plotly.graph_objects.choropleth.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.selecte + d.Marker` instance or dict with compatible + properties """, ), **kwargs @@ -341,8 +343,9 @@ def __init__(self, plotly_name="marker", parent_name="choropleth", **kwargs): "data_docs", """ line - plotly.graph_objects.choropleth.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.marker. + Line` instance or dict with compatible + properties opacity Sets the opacity of the locations. opacitysrc @@ -809,9 +812,9 @@ def __init__(self, plotly_name="colorbar", parent_name="choropleth", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.choropleth.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.choropl + eth.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.choropleth.colorbar.tickformatstopdefaults), @@ -857,8 +860,9 @@ def __init__(self, plotly_name="colorbar", parent_name="choropleth", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.choropleth.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.choropleth.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use choropleth.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/choroplethmapbox/__init__.py b/packages/python/plotly/plotly/validators/choroplethmapbox/__init__.py index 18b55fdfd9d..872d33788b9 100644 --- a/packages/python/plotly/plotly/validators/choroplethmapbox/__init__.py +++ b/packages/python/plotly/plotly/validators/choroplethmapbox/__init__.py @@ -116,9 +116,9 @@ def __init__( "data_docs", """ marker - plotly.graph_objects.choroplethmapbox.unselecte - d.Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.choroplethmapbox.u + nselected.Marker` instance or dict with + compatible properties """, ), **kwargs @@ -289,9 +289,9 @@ def __init__( "data_docs", """ marker - plotly.graph_objects.choroplethmapbox.selected. - Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.choroplethmapbox.s + elected.Marker` instance or dict with + compatible properties """, ), **kwargs @@ -370,8 +370,9 @@ def __init__(self, plotly_name="marker", parent_name="choroplethmapbox", **kwarg "data_docs", """ line - plotly.graph_objects.choroplethmapbox.marker.Li - ne instance or dict with compatible properties + :class:`plotly.graph_objects.choroplethmapbox.m + arker.Line` instance or dict with compatible + properties opacity Sets the opacity of the locations. opacitysrc @@ -834,9 +835,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.choroplethmapbo - x.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.choropl + ethmapbox.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.choroplethmapbox.colorbar.tickformatstopdefau @@ -883,8 +884,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.choroplethmapbox.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.choroplethmapbox.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/cone/__init__.py b/packages/python/plotly/plotly/validators/cone/__init__.py index 420482673bc..6ad6103b467 100644 --- a/packages/python/plotly/plotly/validators/cone/__init__.py +++ b/packages/python/plotly/plotly/validators/cone/__init__.py @@ -847,8 +847,8 @@ def __init__(self, plotly_name="colorbar", parent_name="cone", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.cone.colorbar.T - ickformatstop instances or dicts with + A tuple of :class:`plotly.graph_objects.cone.co + lorbar.Tickformatstop` instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat @@ -895,8 +895,8 @@ def __init__(self, plotly_name="colorbar", parent_name="cone", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.cone.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.cone.colorbar.Titl + e` instance or dict with compatible properties titlefont Deprecated: Please use cone.colorbar.title.font instead. Sets this color bar's title font. Note diff --git a/packages/python/plotly/plotly/validators/contour/__init__.py b/packages/python/plotly/plotly/validators/contour/__init__.py index ef76c471474..d491e22c288 100644 --- a/packages/python/plotly/plotly/validators/contour/__init__.py +++ b/packages/python/plotly/plotly/validators/contour/__init__.py @@ -1099,9 +1099,9 @@ def __init__(self, plotly_name="colorbar", parent_name="contour", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.contour.colorba - r.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.contour + .colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.contour.colorbar.tickformatstopdefaults), @@ -1147,8 +1147,9 @@ def __init__(self, plotly_name="colorbar", parent_name="contour", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.contour.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.contour.colorbar.T + itle` instance or dict with compatible + properties titlefont Deprecated: Please use contour.colorbar.title.font instead. Sets this diff --git a/packages/python/plotly/plotly/validators/contourcarpet/__init__.py b/packages/python/plotly/plotly/validators/contourcarpet/__init__.py index dba40e7aa12..13088733084 100644 --- a/packages/python/plotly/plotly/validators/contourcarpet/__init__.py +++ b/packages/python/plotly/plotly/validators/contourcarpet/__init__.py @@ -762,9 +762,9 @@ def __init__(self, plotly_name="colorbar", parent_name="contourcarpet", **kwargs tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.contourcarpet.c - olorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.contour + carpet.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.contourcarpet.colorbar.tickformatstopdefaults @@ -811,8 +811,9 @@ def __init__(self, plotly_name="colorbar", parent_name="contourcarpet", **kwargs tickwidth Sets the tick width (in px). title - plotly.graph_objects.contourcarpet.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.contourcarpet.colo + rbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use contourcarpet.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/densitymapbox/__init__.py b/packages/python/plotly/plotly/validators/densitymapbox/__init__.py index 17fa3f0d77b..f2a68c87bb5 100644 --- a/packages/python/plotly/plotly/validators/densitymapbox/__init__.py +++ b/packages/python/plotly/plotly/validators/densitymapbox/__init__.py @@ -766,9 +766,9 @@ def __init__(self, plotly_name="colorbar", parent_name="densitymapbox", **kwargs tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.densitymapbox.c - olorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.density + mapbox.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.densitymapbox.colorbar.tickformatstopdefaults @@ -815,8 +815,9 @@ def __init__(self, plotly_name="colorbar", parent_name="densitymapbox", **kwargs tickwidth Sets the tick width (in px). title - plotly.graph_objects.densitymapbox.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.densitymapbox.colo + rbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use densitymapbox.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/funnel/__init__.py b/packages/python/plotly/plotly/validators/funnel/__init__.py index 92e78340850..325ac9f9682 100644 --- a/packages/python/plotly/plotly/validators/funnel/__init__.py +++ b/packages/python/plotly/plotly/validators/funnel/__init__.py @@ -618,8 +618,9 @@ def __init__(self, plotly_name="marker", parent_name="funnel", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.funnel.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.Colo + rBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -640,8 +641,8 @@ def __init__(self, plotly_name="marker", parent_name="funnel", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.funnel.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.Line + ` instance or dict with compatible properties opacity Sets the opacity of the bars. opacitysrc @@ -1007,8 +1008,9 @@ def __init__(self, plotly_name="connector", parent_name="funnel", **kwargs): fillcolor Sets the fill color. line - plotly.graph_objects.funnel.connector.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.connector.L + ine` instance or dict with compatible + properties visible Determines if connector regions and lines are drawn. diff --git a/packages/python/plotly/plotly/validators/funnel/marker/__init__.py b/packages/python/plotly/plotly/validators/funnel/marker/__init__.py index a4ba3b3ac7d..3f20bfb8c3c 100644 --- a/packages/python/plotly/plotly/validators/funnel/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/funnel/marker/__init__.py @@ -332,9 +332,9 @@ def __init__(self, plotly_name="colorbar", parent_name="funnel.marker", **kwargs tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.funnel.marker.c - olorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.funnel. + marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.funnel.marker.colorbar.tickformatstopdefaults @@ -381,8 +381,9 @@ def __init__(self, plotly_name="colorbar", parent_name="funnel.marker", **kwargs tickwidth Sets the tick width (in px). title - plotly.graph_objects.funnel.marker.colorbar.Tit - le instance or dict with compatible properties + :class:`plotly.graph_objects.funnel.marker.colo + rbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use funnel.marker.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/funnelarea/__init__.py b/packages/python/plotly/plotly/validators/funnelarea/__init__.py index c4cecebd38b..7138a3c6d11 100644 --- a/packages/python/plotly/plotly/validators/funnelarea/__init__.py +++ b/packages/python/plotly/plotly/validators/funnelarea/__init__.py @@ -389,8 +389,9 @@ def __init__(self, plotly_name="marker", parent_name="funnelarea", **kwargs): Sets the source reference on plot.ly for colors . line - plotly.graph_objects.funnelarea.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.funnelarea.marker. + Line` instance or dict with compatible + properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/heatmap/__init__.py b/packages/python/plotly/plotly/validators/heatmap/__init__.py index 3329ab29aaa..120cce6e536 100644 --- a/packages/python/plotly/plotly/validators/heatmap/__init__.py +++ b/packages/python/plotly/plotly/validators/heatmap/__init__.py @@ -998,9 +998,9 @@ def __init__(self, plotly_name="colorbar", parent_name="heatmap", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.heatmap.colorba - r.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.heatmap + .colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.heatmap.colorbar.tickformatstopdefaults), @@ -1046,8 +1046,9 @@ def __init__(self, plotly_name="colorbar", parent_name="heatmap", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmap.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmap.colorbar.T + itle` instance or dict with compatible + properties titlefont Deprecated: Please use heatmap.colorbar.title.font instead. Sets this diff --git a/packages/python/plotly/plotly/validators/heatmapgl/__init__.py b/packages/python/plotly/plotly/validators/heatmapgl/__init__.py index b7f37ae0b18..c1b98b3a0ee 100644 --- a/packages/python/plotly/plotly/validators/heatmapgl/__init__.py +++ b/packages/python/plotly/plotly/validators/heatmapgl/__init__.py @@ -756,9 +756,9 @@ def __init__(self, plotly_name="colorbar", parent_name="heatmapgl", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.heatmapgl.color - bar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.heatmap + gl.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.heatmapgl.colorbar.tickformatstopdefaults), @@ -804,8 +804,9 @@ def __init__(self, plotly_name="colorbar", parent_name="heatmapgl", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.heatmapgl.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.heatmapgl.colorbar + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use heatmapgl.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/histogram/__init__.py b/packages/python/plotly/plotly/validators/histogram/__init__.py index ff71d61b21c..4b5d5d75996 100644 --- a/packages/python/plotly/plotly/validators/histogram/__init__.py +++ b/packages/python/plotly/plotly/validators/histogram/__init__.py @@ -306,11 +306,13 @@ def __init__(self, plotly_name="unselected", parent_name="histogram", **kwargs): "data_docs", """ marker - plotly.graph_objects.histogram.unselected.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselect + ed.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.histogram.unselected.Textf - ont instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.unselect + ed.Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -442,11 +444,13 @@ def __init__(self, plotly_name="selected", parent_name="histogram", **kwargs): "data_docs", """ marker - plotly.graph_objects.histogram.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.selected + .Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.histogram.selected.Textfon - t instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.selected + .Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -637,8 +641,9 @@ def __init__(self, plotly_name="marker", parent_name="histogram", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.histogram.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -659,8 +664,9 @@ def __init__(self, plotly_name="marker", parent_name="histogram", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.histogram.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram.marker.L + ine` instance or dict with compatible + properties opacity Sets the opacity of the bars. opacitysrc diff --git a/packages/python/plotly/plotly/validators/histogram/marker/__init__.py b/packages/python/plotly/plotly/validators/histogram/marker/__init__.py index ba4ca320e33..3662dd161e8 100644 --- a/packages/python/plotly/plotly/validators/histogram/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/histogram/marker/__init__.py @@ -342,9 +342,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram.marke - r.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.histogr + am.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram.marker.colorbar.tickformatstopdefau @@ -391,8 +391,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram.marker.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.histogram.marker.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/histogram2d/__init__.py b/packages/python/plotly/plotly/validators/histogram2d/__init__.py index 409dab2bf47..4305e41ab5d 100644 --- a/packages/python/plotly/plotly/validators/histogram2d/__init__.py +++ b/packages/python/plotly/plotly/validators/histogram2d/__init__.py @@ -1032,9 +1032,9 @@ def __init__(self, plotly_name="colorbar", parent_name="histogram2d", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2d.col - orbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.histogr + am2d.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram2d.colorbar.tickformatstopdefaults), @@ -1081,8 +1081,9 @@ def __init__(self, plotly_name="colorbar", parent_name="histogram2d", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2d.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.histogram2d.colorb + ar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use histogram2d.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/histogram2dcontour/__init__.py b/packages/python/plotly/plotly/validators/histogram2dcontour/__init__.py index f182f3c5fbd..f2821dba9dd 100644 --- a/packages/python/plotly/plotly/validators/histogram2dcontour/__init__.py +++ b/packages/python/plotly/plotly/validators/histogram2dcontour/__init__.py @@ -1171,9 +1171,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.histogram2dcont - our.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.histogr + am2dcontour.colorbar.Tickformatstop` instances + or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.histogram2dcontour.colorbar.tickformatstopdef @@ -1220,9 +1220,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.histogram2dcontour.colorba - r.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.histogram2dcontour + .colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use histogram2dcontour.colorbar.title.font instead. diff --git a/packages/python/plotly/plotly/validators/indicator/__init__.py b/packages/python/plotly/plotly/validators/indicator/__init__.py index bfc98c1494f..d4ebfb32abd 100644 --- a/packages/python/plotly/plotly/validators/indicator/__init__.py +++ b/packages/python/plotly/plotly/validators/indicator/__init__.py @@ -240,8 +240,8 @@ def __init__(self, plotly_name="gauge", parent_name="indicator", **kwargs): "data_docs", """ axis - plotly.graph_objects.indicator.gauge.Axis - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Ax + is` instance or dict with compatible properties bar Set the appearance of the gauge's value bgcolor @@ -255,17 +255,18 @@ def __init__(self, plotly_name="gauge", parent_name="indicator", **kwargs): shape Set the shape of the gauge steps - A tuple of - plotly.graph_objects.indicator.gauge.Step - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.indicat + or.gauge.Step` instances or dicts with + compatible properties stepdefaults When used in a template (as layout.template.dat a.indicator.gauge.stepdefaults), sets the default property values to use for elements of indicator.gauge.steps threshold - plotly.graph_objects.indicator.gauge.Threshold - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.Th + reshold` instance or dict with compatible + properties """, ), **kwargs @@ -316,13 +317,15 @@ def __init__(self, plotly_name="delta", parent_name="indicator", **kwargs): "data_docs", """ decreasing - plotly.graph_objects.indicator.delta.Decreasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.De + creasing` instance or dict with compatible + properties font Set the font used to display the delta increasing - plotly.graph_objects.indicator.delta.Increasing - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.delta.In + creasing` instance or dict with compatible + properties position Sets the position of delta with respect to the number. diff --git a/packages/python/plotly/plotly/validators/indicator/gauge/__init__.py b/packages/python/plotly/plotly/validators/indicator/gauge/__init__.py index 78077f92e7e..b2e025c864d 100644 --- a/packages/python/plotly/plotly/validators/indicator/gauge/__init__.py +++ b/packages/python/plotly/plotly/validators/indicator/gauge/__init__.py @@ -13,8 +13,8 @@ def __init__( "data_docs", """ line - plotly.graph_objects.indicator.gauge.threshold. - Line instance or dict with compatible + :class:`plotly.graph_objects.indicator.gauge.th + reshold.Line` instance or dict with compatible properties thickness Sets the thickness of the threshold line as a @@ -62,8 +62,9 @@ def __init__(self, plotly_name="steps", parent_name="indicator.gauge", **kwargs) color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.step.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.st + ep.Line` instance or dict with compatible + properties name When used in a template, named items are created in the output figure in addition to any @@ -173,8 +174,9 @@ def __init__(self, plotly_name="bar", parent_name="indicator.gauge", **kwargs): color Sets the background color of the arc. line - plotly.graph_objects.indicator.gauge.bar.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.indicator.gauge.ba + r.Line` instance or dict with compatible + properties thickness Sets the thickness of the bar as a fraction of the total thickness of the gauge. @@ -293,9 +295,9 @@ def __init__(self, plotly_name="axis", parent_name="indicator.gauge", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.indicator.gauge - .axis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.indicat + or.gauge.axis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.indicator.gauge.axis.tickformatstopdefaults), diff --git a/packages/python/plotly/plotly/validators/isosurface/__init__.py b/packages/python/plotly/plotly/validators/isosurface/__init__.py index 4c96644fa71..ddec9ed6858 100644 --- a/packages/python/plotly/plotly/validators/isosurface/__init__.py +++ b/packages/python/plotly/plotly/validators/isosurface/__init__.py @@ -297,14 +297,14 @@ def __init__(self, plotly_name="slices", parent_name="isosurface", **kwargs): "data_docs", """ x - plotly.graph_objects.isosurface.slices.X - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices. + X` instance or dict with compatible properties y - plotly.graph_objects.isosurface.slices.Y - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices. + Y` instance or dict with compatible properties z - plotly.graph_objects.isosurface.slices.Z - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.slices. + Z` instance or dict with compatible properties """, ), **kwargs @@ -930,9 +930,9 @@ def __init__(self, plotly_name="colorbar", parent_name="isosurface", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.isosurface.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.isosurf + ace.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.isosurface.colorbar.tickformatstopdefaults), @@ -978,8 +978,9 @@ def __init__(self, plotly_name="colorbar", parent_name="isosurface", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.isosurface.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.isosurface.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use isosurface.colorbar.title.font instead. Sets @@ -1109,14 +1110,14 @@ def __init__(self, plotly_name="caps", parent_name="isosurface", **kwargs): "data_docs", """ x - plotly.graph_objects.isosurface.caps.X instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.caps.X` + instance or dict with compatible properties y - plotly.graph_objects.isosurface.caps.Y instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Y` + instance or dict with compatible properties z - plotly.graph_objects.isosurface.caps.Z instance - or dict with compatible properties + :class:`plotly.graph_objects.isosurface.caps.Z` + instance or dict with compatible properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/layout/__init__.py b/packages/python/plotly/plotly/validators/layout/__init__.py index c8585f98e33..6c3fd650a42 100644 --- a/packages/python/plotly/plotly/validators/layout/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/__init__.py @@ -337,9 +337,9 @@ def __init__(self, plotly_name="yaxis", parent_name="layout", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.yaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout. + yaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.yaxis.tickformatstopdefaults), sets the @@ -392,8 +392,8 @@ def __init__(self, plotly_name="yaxis", parent_name="layout", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.yaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.yaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.yaxis.title.font instead. Sets this axis' title font. Note that @@ -642,11 +642,13 @@ def __init__(self, plotly_name="xaxis", parent_name="layout", **kwargs): negative, regardless of the input data. Applies only to linear axes. rangeselector - plotly.graph_objects.layout.xaxis.Rangeselector - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Range + selector` instance or dict with compatible + properties rangeslider - plotly.graph_objects.layout.xaxis.Rangeslider - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Range + slider` instance or dict with compatible + properties scaleanchor If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the @@ -773,9 +775,9 @@ def __init__(self, plotly_name="xaxis", parent_name="layout", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.xaxis.Ti - ckformatstop instances or dicts with compatible - properties + A tuple of :class:`plotly.graph_objects.layout. + xaxis.Tickformatstop` instances or dicts with + compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.xaxis.tickformatstopdefaults), sets the @@ -828,8 +830,8 @@ def __init__(self, plotly_name="xaxis", parent_name="layout", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.xaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.xaxis.Title + ` instance or dict with compatible properties titlefont Deprecated: Please use layout.xaxis.title.font instead. Sets this axis' title font. Note that @@ -1018,9 +1020,9 @@ def __init__(self, plotly_name="updatemenus", parent_name="layout", **kwargs): Sets the width (in px) of the border enclosing the update menu. buttons - A tuple of - plotly.graph_objects.layout.updatemenu.Button - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + updatemenu.Button` instances or dicts with + compatible properties buttondefaults When used in a template (as layout.template.lay out.updatemenu.buttondefaults), sets the @@ -1261,19 +1263,20 @@ def __init__(self, plotly_name="ternary", parent_name="layout", **kwargs): "data_docs", """ aaxis - plotly.graph_objects.layout.ternary.Aaxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Aax + is` instance or dict with compatible properties baxis - plotly.graph_objects.layout.ternary.Baxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Bax + is` instance or dict with compatible properties bgcolor Set the background color of the subplot caxis - plotly.graph_objects.layout.ternary.Caxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Cax + is` instance or dict with compatible properties domain - plotly.graph_objects.layout.ternary.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.Dom + ain` instance or dict with compatible + properties sum The number each triplet should sum to, and the maximum range of each axis @@ -1301,11 +1304,11 @@ def __init__(self, plotly_name="template", parent_name="layout", **kwargs): "data_docs", """ data - plotly.graph_objects.layout.template.Data - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.template.Da + ta` instance or dict with compatible properties layout - plotly.graph_objects.Layout instance or dict - with compatible properties + :class:`plotly.graph_objects.Layout` instance + or dict with compatible properties """, ), **kwargs @@ -1386,8 +1389,9 @@ def __init__(self, plotly_name="sliders", parent_name="layout", **kwargs): Sets the width (in px) of the border enclosing the slider. currentvalue - plotly.graph_objects.layout.slider.Currentvalue - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Curr + entvalue` instance or dict with compatible + properties font Sets the font of the slider step labels. len @@ -1416,9 +1420,9 @@ def __init__(self, plotly_name="sliders", parent_name="layout", **kwargs): Set the padding of the slider component along each side. steps - A tuple of - plotly.graph_objects.layout.slider.Step - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + slider.Step` instances or dicts with compatible + properties stepdefaults When used in a template (as layout.template.layout.slider.stepdefaults), @@ -1443,8 +1447,9 @@ def __init__(self, plotly_name="sliders", parent_name="layout", **kwargs): tickwidth Sets the tick width (in px). transition - plotly.graph_objects.layout.slider.Transition - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.slider.Tran + sition` instance or dict with compatible + properties visible Determines whether or not the slider is visible. @@ -1519,8 +1524,8 @@ def __init__(self, plotly_name="shapes", parent_name="layout", **kwargs): Specifies whether shapes are drawn below or above traces. line - plotly.graph_objects.layout.shape.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties name When used in a template, named items are created in the output figure in addition to any @@ -1721,9 +1726,9 @@ def __init__(self, plotly_name="scene", parent_name="layout", **kwargs): "data_docs", """ annotations - A tuple of - plotly.graph_objects.layout.scene.Annotation - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.Annotation` instances or dicts with + compatible properties annotationdefaults When used in a template (as layout.template.lay out.scene.annotationdefaults), sets the default @@ -1747,11 +1752,11 @@ def __init__(self, plotly_name="scene", parent_name="layout", **kwargs): bgcolor camera - plotly.graph_objects.layout.scene.Camera - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Camer + a` instance or dict with compatible properties domain - plotly.graph_objects.layout.scene.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.Domai + n` instance or dict with compatible properties dragmode Determines the mode of drag interactions for this scene. @@ -1763,14 +1768,14 @@ def __init__(self, plotly_name="scene", parent_name="layout", **kwargs): camera attributes. Defaults to `layout.uirevision`. xaxis - plotly.graph_objects.layout.scene.XAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.XAxis + ` instance or dict with compatible properties yaxis - plotly.graph_objects.layout.scene.YAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.YAxis + ` instance or dict with compatible properties zaxis - plotly.graph_objects.layout.scene.ZAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.ZAxis + ` instance or dict with compatible properties """, ), **kwargs @@ -1854,8 +1859,9 @@ def __init__(self, plotly_name="polar", parent_name="layout", **kwargs): "data_docs", """ angularaxis - plotly.graph_objects.layout.polar.AngularAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Angul + arAxis` instance or dict with compatible + properties bargap Sets the gap between bars of adjacent location coordinates. Values are unitless, they @@ -1871,8 +1877,8 @@ def __init__(self, plotly_name="polar", parent_name="layout", **kwargs): bgcolor Set the background color of the subplot domain - plotly.graph_objects.layout.polar.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Domai + n` instance or dict with compatible properties gridshape Determines if the radial axis grid lines and angular axis line are drawn as "circular" @@ -1886,8 +1892,9 @@ def __init__(self, plotly_name="polar", parent_name="layout", **kwargs): Sets the fraction of the radius to cut out of the polar subplot. radialaxis - plotly.graph_objects.layout.polar.RadialAxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.Radia + lAxis` instance or dict with compatible + properties sector Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to @@ -2082,15 +2089,15 @@ def __init__(self, plotly_name="mapbox", parent_name="layout", **kwargs): Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing). center - plotly.graph_objects.layout.mapbox.Center - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Cent + er` instance or dict with compatible properties domain - plotly.graph_objects.layout.mapbox.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.Doma + in` instance or dict with compatible properties layers - A tuple of - plotly.graph_objects.layout.mapbox.Layer - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + mapbox.Layer` instances or dicts with + compatible properties layerdefaults When used in a template (as layout.template.layout.mapbox.layerdefaults), @@ -2186,8 +2193,8 @@ def __init__(self, plotly_name="legend", parent_name="layout", **kwargs): orientation Sets the orientation of the legend. title - plotly.graph_objects.layout.legend.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.legend.Titl + e` instance or dict with compatible properties tracegroupgap Sets the amount of vertical space (in px) between legend groups. @@ -2507,8 +2514,8 @@ def __init__(self, plotly_name="grid", parent_name="layout", **kwargs): different length, if you want to leave a row at the end for non-cartesian subplots. domain - plotly.graph_objects.layout.grid.Domain - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.grid.Domain + ` instance or dict with compatible properties pattern If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can @@ -2598,8 +2605,8 @@ def __init__(self, plotly_name="geo", parent_name="layout", **kwargs): bgcolor Set the background color of the map center - plotly.graph_objects.layout.geo.Center instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Center` + instance or dict with compatible properties coastlinecolor Sets the coastline color. coastlinewidth @@ -2610,8 +2617,8 @@ def __init__(self, plotly_name="geo", parent_name="layout", **kwargs): Sets line width (in px) of the country boundaries. domain - plotly.graph_objects.layout.geo.Domain instance - or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Domain` + instance or dict with compatible properties fitbounds Determines if this subplot's view settings are auto-computed to fit trace data. On scoped @@ -2640,16 +2647,17 @@ def __init__(self, plotly_name="geo", parent_name="layout", **kwargs): landcolor Sets the land mass color. lataxis - plotly.graph_objects.layout.geo.Lataxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lataxis + ` instance or dict with compatible properties lonaxis - plotly.graph_objects.layout.geo.Lonaxis - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Lonaxis + ` instance or dict with compatible properties oceancolor Sets the ocean color projection - plotly.graph_objects.layout.geo.Projection - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.geo.Project + ion` instance or dict with compatible + properties resolution Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds @@ -3010,8 +3018,9 @@ def __init__(self, plotly_name="coloraxis", parent_name="layout", **kwargs): trace color array(s) and if set, `cmax` must be set as well. colorbar - plotly.graph_objects.layout.coloraxis.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.coloraxis.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized @@ -3344,8 +3353,9 @@ def __init__(self, plotly_name="annotations", parent_name="layout", **kwargs): (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.annotation.Hoverlab - el instance or dict with compatible properties + :class:`plotly.graph_objects.layout.annotation. + Hoverlabel` instance or dict with compatible + properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label diff --git a/packages/python/plotly/plotly/validators/layout/coloraxis/__init__.py b/packages/python/plotly/plotly/validators/layout/coloraxis/__init__.py index 107bf61d809..4642755291e 100644 --- a/packages/python/plotly/plotly/validators/layout/coloraxis/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/coloraxis/__init__.py @@ -187,9 +187,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.coloraxi - s.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + coloraxis.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.coloraxis.colorbar.tickformatstopdefaults), @@ -236,8 +236,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.coloraxis.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.layout.coloraxis.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/layout/geo/__init__.py b/packages/python/plotly/plotly/validators/layout/geo/__init__.py index c141691d691..6def604c85e 100644 --- a/packages/python/plotly/plotly/validators/layout/geo/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/geo/__init__.py @@ -257,8 +257,8 @@ def __init__(self, plotly_name="projection", parent_name="layout.geo", **kwargs) parallels (tangent, secant) where the cone intersects the sphere. rotation - plotly.graph_objects.layout.geo.projection.Rota - tion instance or dict with compatible + :class:`plotly.graph_objects.layout.geo.project + ion.Rotation` instance or dict with compatible properties scale Zooms in or out on the map view. A scale of 1 diff --git a/packages/python/plotly/plotly/validators/layout/mapbox/__init__.py b/packages/python/plotly/plotly/validators/layout/mapbox/__init__.py index 82fa74f23ff..bd501352538 100644 --- a/packages/python/plotly/plotly/validators/layout/mapbox/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/mapbox/__init__.py @@ -111,8 +111,9 @@ def __init__(self, plotly_name="layers", parent_name="layout.mapbox", **kwargs): set to '', the layer will be inserted above every existing layer. circle - plotly.graph_objects.layout.mapbox.layer.Circle - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Circle` instance or dict with compatible + properties color Sets the primary layer color. If `type` is "circle", color corresponds to the circle color @@ -130,11 +131,13 @@ def __init__(self, plotly_name="layers", parent_name="layout.mapbox", **kwargs): right, bottom left. Only has an effect for "image" `sourcetype`. fill - plotly.graph_objects.layout.mapbox.layer.Fill - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Fill` instance or dict with compatible + properties line - plotly.graph_objects.layout.mapbox.layer.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Line` instance or dict with compatible + properties maxzoom Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to @@ -185,8 +188,9 @@ def __init__(self, plotly_name="layers", parent_name="layout.mapbox", **kwargs): Sets the source type for this layer, that is the type of the layer data. symbol - plotly.graph_objects.layout.mapbox.layer.Symbol - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.mapbox.laye + r.Symbol` instance or dict with compatible + properties templateitemname Used to refer to a named item in this array in the template. Named items from the template diff --git a/packages/python/plotly/plotly/validators/layout/polar/__init__.py b/packages/python/plotly/plotly/validators/layout/polar/__init__.py index 5d23a913359..07a3181894f 100644 --- a/packages/python/plotly/plotly/validators/layout/polar/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/polar/__init__.py @@ -251,9 +251,9 @@ def __init__(self, plotly_name="radialaxis", parent_name="layout.polar", **kwarg tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.ra - dialaxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + polar.radialaxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.polar.radialaxis.tickformatstopdefaults), @@ -300,8 +300,9 @@ def __init__(self, plotly_name="radialaxis", parent_name="layout.polar", **kwarg tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.polar.radialaxis.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.layout.polar.radia + laxis.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.polar.radialaxis.title.font instead. @@ -633,9 +634,9 @@ def __init__(self, plotly_name="angularaxis", parent_name="layout.polar", **kwar tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.polar.an - gularaxis.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.layout. + polar.angularaxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.polar.angularaxis.tickformatstopdefaults), diff --git a/packages/python/plotly/plotly/validators/layout/scene/__init__.py b/packages/python/plotly/plotly/validators/layout/scene/__init__.py index 6a23998f375..dea2b912d79 100644 --- a/packages/python/plotly/plotly/validators/layout/scene/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/scene/__init__.py @@ -224,9 +224,9 @@ def __init__(self, plotly_name="zaxis", parent_name="layout.scene", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.scene.za - xis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.zaxis.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.scene.zaxis.tickformatstopdefaults), sets @@ -272,8 +272,9 @@ def __init__(self, plotly_name="zaxis", parent_name="layout.scene", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.zaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.zaxis + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.scene.zaxis.title.font instead. Sets @@ -530,9 +531,9 @@ def __init__(self, plotly_name="yaxis", parent_name="layout.scene", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.scene.ya - xis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.yaxis.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.scene.yaxis.tickformatstopdefaults), sets @@ -578,8 +579,9 @@ def __init__(self, plotly_name="yaxis", parent_name="layout.scene", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.yaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.yaxis + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.scene.yaxis.title.font instead. Sets @@ -836,9 +838,9 @@ def __init__(self, plotly_name="xaxis", parent_name="layout.scene", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.scene.xa - xis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + scene.xaxis.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.scene.xaxis.tickformatstopdefaults), sets @@ -884,8 +886,9 @@ def __init__(self, plotly_name="xaxis", parent_name="layout.scene", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.scene.xaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.scene.xaxis + .Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.scene.xaxis.title.font instead. Sets @@ -1014,8 +1017,8 @@ def __init__(self, plotly_name="camera", parent_name="layout.scene", **kwargs): vector. This vector determines the view point about the origin of this scene. projection - plotly.graph_objects.layout.scene.camera.Projec - tion instance or dict with compatible + :class:`plotly.graph_objects.layout.scene.camer + a.Projection` instance or dict with compatible properties up Sets the (x,y,z) components of the 'up' camera @@ -1168,9 +1171,9 @@ def __init__(self, plotly_name="annotations", parent_name="layout.scene", **kwar (default) lets the text set the box height. Taller text will be clipped. hoverlabel - plotly.graph_objects.layout.scene.annotation.Ho - verlabel instance or dict with compatible - properties + :class:`plotly.graph_objects.layout.scene.annot + ation.Hoverlabel` instance or dict with + compatible properties hovertext Sets text to appear when hovering over this annotation. If omitted or blank, no hover label diff --git a/packages/python/plotly/plotly/validators/layout/template/__init__.py b/packages/python/plotly/plotly/validators/layout/template/__init__.py index 1908e401d65..ef9803c725f 100644 --- a/packages/python/plotly/plotly/validators/layout/template/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/template/__init__.py @@ -29,147 +29,177 @@ def __init__(self, plotly_name="data", parent_name="layout.template", **kwargs): "data_docs", """ area - A tuple of plotly.graph_objects.Area instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Area` + instances or dicts with compatible properties barpolar - A tuple of plotly.graph_objects.Barpolar + A tuple of + :class:`plotly.graph_objects.Barpolar` instances or dicts with compatible properties bar - A tuple of plotly.graph_objects.Bar instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Bar` + instances or dicts with compatible properties box - A tuple of plotly.graph_objects.Box instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Box` + instances or dicts with compatible properties candlestick - A tuple of plotly.graph_objects.Candlestick + A tuple of + :class:`plotly.graph_objects.Candlestick` instances or dicts with compatible properties carpet - A tuple of plotly.graph_objects.Carpet + A tuple of :class:`plotly.graph_objects.Carpet` instances or dicts with compatible properties choroplethmapbox A tuple of - plotly.graph_objects.Choroplethmapbox instances - or dicts with compatible properties + :class:`plotly.graph_objects.Choroplethmapbox` + instances or dicts with compatible properties choropleth - A tuple of plotly.graph_objects.Choropleth + A tuple of + :class:`plotly.graph_objects.Choropleth` instances or dicts with compatible properties cone - A tuple of plotly.graph_objects.Cone instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Cone` + instances or dicts with compatible properties contourcarpet - A tuple of plotly.graph_objects.Contourcarpet + A tuple of + :class:`plotly.graph_objects.Contourcarpet` instances or dicts with compatible properties contour - A tuple of plotly.graph_objects.Contour - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.Contour` instances + or dicts with compatible properties densitymapbox - A tuple of plotly.graph_objects.Densitymapbox + A tuple of + :class:`plotly.graph_objects.Densitymapbox` instances or dicts with compatible properties funnelarea - A tuple of plotly.graph_objects.Funnelarea + A tuple of + :class:`plotly.graph_objects.Funnelarea` instances or dicts with compatible properties funnel - A tuple of plotly.graph_objects.Funnel + A tuple of :class:`plotly.graph_objects.Funnel` instances or dicts with compatible properties heatmapgl - A tuple of plotly.graph_objects.Heatmapgl + A tuple of + :class:`plotly.graph_objects.Heatmapgl` instances or dicts with compatible properties heatmap - A tuple of plotly.graph_objects.Heatmap - instances or dicts with compatible properties - histogram2dcontour A tuple of - plotly.graph_objects.Histogram2dContour - instances or dicts with compatible properties + :class:`plotly.graph_objects.Heatmap` instances + or dicts with compatible properties + histogram2dcontour + A tuple of :class:`plotly.graph_objects.Histogr + am2dContour` instances or dicts with compatible + properties histogram2d - A tuple of plotly.graph_objects.Histogram2d + A tuple of + :class:`plotly.graph_objects.Histogram2d` instances or dicts with compatible properties histogram - A tuple of plotly.graph_objects.Histogram + A tuple of + :class:`plotly.graph_objects.Histogram` instances or dicts with compatible properties image - A tuple of plotly.graph_objects.Image instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Image` + instances or dicts with compatible properties indicator - A tuple of plotly.graph_objects.Indicator + A tuple of + :class:`plotly.graph_objects.Indicator` instances or dicts with compatible properties isosurface - A tuple of plotly.graph_objects.Isosurface + A tuple of + :class:`plotly.graph_objects.Isosurface` instances or dicts with compatible properties mesh3d - A tuple of plotly.graph_objects.Mesh3d + A tuple of :class:`plotly.graph_objects.Mesh3d` instances or dicts with compatible properties ohlc - A tuple of plotly.graph_objects.Ohlc instances - or dicts with compatible properties - parcats - A tuple of plotly.graph_objects.Parcats + A tuple of :class:`plotly.graph_objects.Ohlc` instances or dicts with compatible properties + parcats + A tuple of + :class:`plotly.graph_objects.Parcats` instances + or dicts with compatible properties parcoords - A tuple of plotly.graph_objects.Parcoords + A tuple of + :class:`plotly.graph_objects.Parcoords` instances or dicts with compatible properties pie - A tuple of plotly.graph_objects.Pie instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Pie` + instances or dicts with compatible properties pointcloud - A tuple of plotly.graph_objects.Pointcloud + A tuple of + :class:`plotly.graph_objects.Pointcloud` instances or dicts with compatible properties sankey - A tuple of plotly.graph_objects.Sankey + A tuple of :class:`plotly.graph_objects.Sankey` instances or dicts with compatible properties scatter3d - A tuple of plotly.graph_objects.Scatter3d + A tuple of + :class:`plotly.graph_objects.Scatter3d` instances or dicts with compatible properties scattercarpet - A tuple of plotly.graph_objects.Scattercarpet + A tuple of + :class:`plotly.graph_objects.Scattercarpet` instances or dicts with compatible properties scattergeo - A tuple of plotly.graph_objects.Scattergeo + A tuple of + :class:`plotly.graph_objects.Scattergeo` instances or dicts with compatible properties scattergl - A tuple of plotly.graph_objects.Scattergl + A tuple of + :class:`plotly.graph_objects.Scattergl` instances or dicts with compatible properties scattermapbox - A tuple of plotly.graph_objects.Scattermapbox + A tuple of + :class:`plotly.graph_objects.Scattermapbox` instances or dicts with compatible properties scatterpolargl - A tuple of plotly.graph_objects.Scatterpolargl + A tuple of + :class:`plotly.graph_objects.Scatterpolargl` instances or dicts with compatible properties scatterpolar - A tuple of plotly.graph_objects.Scatterpolar + A tuple of + :class:`plotly.graph_objects.Scatterpolar` instances or dicts with compatible properties scatter - A tuple of plotly.graph_objects.Scatter - instances or dicts with compatible properties + A tuple of + :class:`plotly.graph_objects.Scatter` instances + or dicts with compatible properties scatterternary - A tuple of plotly.graph_objects.Scatterternary + A tuple of + :class:`plotly.graph_objects.Scatterternary` instances or dicts with compatible properties splom - A tuple of plotly.graph_objects.Splom instances - or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.Splom` + instances or dicts with compatible properties streamtube - A tuple of plotly.graph_objects.Streamtube + A tuple of + :class:`plotly.graph_objects.Streamtube` instances or dicts with compatible properties sunburst - A tuple of plotly.graph_objects.Sunburst + A tuple of + :class:`plotly.graph_objects.Sunburst` instances or dicts with compatible properties surface - A tuple of plotly.graph_objects.Surface - instances or dicts with compatible properties - table - A tuple of plotly.graph_objects.Table instances + A tuple of + :class:`plotly.graph_objects.Surface` instances or dicts with compatible properties - treemap - A tuple of plotly.graph_objects.Treemap + table + A tuple of :class:`plotly.graph_objects.Table` instances or dicts with compatible properties + treemap + A tuple of + :class:`plotly.graph_objects.Treemap` instances + or dicts with compatible properties violin - A tuple of plotly.graph_objects.Violin + A tuple of :class:`plotly.graph_objects.Violin` instances or dicts with compatible properties volume - A tuple of plotly.graph_objects.Volume + A tuple of :class:`plotly.graph_objects.Volume` instances or dicts with compatible properties waterfall - A tuple of plotly.graph_objects.Waterfall + A tuple of + :class:`plotly.graph_objects.Waterfall` instances or dicts with compatible properties """, ), diff --git a/packages/python/plotly/plotly/validators/layout/ternary/__init__.py b/packages/python/plotly/plotly/validators/layout/ternary/__init__.py index 7afc3457480..5308d77002e 100644 --- a/packages/python/plotly/plotly/validators/layout/ternary/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/ternary/__init__.py @@ -216,9 +216,9 @@ def __init__(self, plotly_name="caxis", parent_name="layout.ternary", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary. - caxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + ternary.caxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.ternary.caxis.tickformatstopdefaults), sets @@ -264,8 +264,9 @@ def __init__(self, plotly_name="caxis", parent_name="layout.ternary", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.caxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.cax + is.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.ternary.caxis.title.font instead. Sets @@ -453,9 +454,9 @@ def __init__(self, plotly_name="baxis", parent_name="layout.ternary", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary. - baxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + ternary.baxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.ternary.baxis.tickformatstopdefaults), sets @@ -501,8 +502,9 @@ def __init__(self, plotly_name="baxis", parent_name="layout.ternary", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.baxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.bax + is.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.ternary.baxis.title.font instead. Sets @@ -676,9 +678,9 @@ def __init__(self, plotly_name="aaxis", parent_name="layout.ternary", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.layout.ternary. - aaxis.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.layout. + ternary.aaxis.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.lay out.ternary.aaxis.tickformatstopdefaults), sets @@ -724,8 +726,9 @@ def __init__(self, plotly_name="aaxis", parent_name="layout.ternary", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.layout.ternary.aaxis.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.layout.ternary.aax + is.Title` instance or dict with compatible + properties titlefont Deprecated: Please use layout.ternary.aaxis.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/layout/xaxis/__init__.py b/packages/python/plotly/plotly/validators/layout/xaxis/__init__.py index 92e9813f914..ccfef02df1a 100644 --- a/packages/python/plotly/plotly/validators/layout/xaxis/__init__.py +++ b/packages/python/plotly/plotly/validators/layout/xaxis/__init__.py @@ -765,8 +765,8 @@ def __init__(self, plotly_name="rangeslider", parent_name="layout.xaxis", **kwar be visible. If visible, perpendicular axes will be set to `fixedrange` yaxis - plotly.graph_objects.layout.xaxis.rangeslider.Y - Axis instance or dict with compatible + :class:`plotly.graph_objects.layout.xaxis.range + slider.YAxis` instance or dict with compatible properties """, ), diff --git a/packages/python/plotly/plotly/validators/mesh3d/__init__.py b/packages/python/plotly/plotly/validators/mesh3d/__init__.py index f7e4b2bea29..cce462934b7 100644 --- a/packages/python/plotly/plotly/validators/mesh3d/__init__.py +++ b/packages/python/plotly/plotly/validators/mesh3d/__init__.py @@ -1073,9 +1073,9 @@ def __init__(self, plotly_name="colorbar", parent_name="mesh3d", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.mesh3d.colorbar - .Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.mesh3d. + colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.mesh3d.colorbar.tickformatstopdefaults), sets @@ -1121,8 +1121,9 @@ def __init__(self, plotly_name="colorbar", parent_name="mesh3d", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.mesh3d.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.mesh3d.colorbar.Ti + tle` instance or dict with compatible + properties titlefont Deprecated: Please use mesh3d.colorbar.title.font instead. Sets this diff --git a/packages/python/plotly/plotly/validators/ohlc/__init__.py b/packages/python/plotly/plotly/validators/ohlc/__init__.py index ef7886b1f6b..71d45c63949 100644 --- a/packages/python/plotly/plotly/validators/ohlc/__init__.py +++ b/packages/python/plotly/plotly/validators/ohlc/__init__.py @@ -407,8 +407,8 @@ def __init__(self, plotly_name="increasing", parent_name="ohlc", **kwargs): "data_docs", """ line - plotly.graph_objects.ohlc.increasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.ohlc.increasing.Li + ne` instance or dict with compatible properties """, ), **kwargs @@ -600,8 +600,8 @@ def __init__(self, plotly_name="decreasing", parent_name="ohlc", **kwargs): "data_docs", """ line - plotly.graph_objects.ohlc.decreasing.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.ohlc.decreasing.Li + ne` instance or dict with compatible properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/parcats/__init__.py b/packages/python/plotly/plotly/validators/parcats/__init__.py index 0224d9a4b32..0c8edb0431d 100644 --- a/packages/python/plotly/plotly/validators/parcats/__init__.py +++ b/packages/python/plotly/plotly/validators/parcats/__init__.py @@ -230,8 +230,9 @@ def __init__(self, plotly_name="line", parent_name="parcats", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcats.line.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.parcats.line.Color + Bar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The diff --git a/packages/python/plotly/plotly/validators/parcats/line/__init__.py b/packages/python/plotly/plotly/validators/parcats/line/__init__.py index 7717d7df62a..43368720e29 100644 --- a/packages/python/plotly/plotly/validators/parcats/line/__init__.py +++ b/packages/python/plotly/plotly/validators/parcats/line/__init__.py @@ -226,9 +226,9 @@ def __init__(self, plotly_name="colorbar", parent_name="parcats.line", **kwargs) tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcats.line.co - lorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.parcats + .line.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.parcats.line.colorbar.tickformatstopdefaults) @@ -275,8 +275,9 @@ def __init__(self, plotly_name="colorbar", parent_name="parcats.line", **kwargs) tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcats.line.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.parcats.line.color + bar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use parcats.line.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/parcoords/__init__.py b/packages/python/plotly/plotly/validators/parcoords/__init__.py index 859ad6c6f67..cfbaee64c17 100644 --- a/packages/python/plotly/plotly/validators/parcoords/__init__.py +++ b/packages/python/plotly/plotly/validators/parcoords/__init__.py @@ -253,8 +253,9 @@ def __init__(self, plotly_name="line", parent_name="parcoords", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.parcoords.line.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.Col + orBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The diff --git a/packages/python/plotly/plotly/validators/parcoords/line/__init__.py b/packages/python/plotly/plotly/validators/parcoords/line/__init__.py index 34b77641dd0..6296ab57ebe 100644 --- a/packages/python/plotly/plotly/validators/parcoords/line/__init__.py +++ b/packages/python/plotly/plotly/validators/parcoords/line/__init__.py @@ -197,9 +197,9 @@ def __init__(self, plotly_name="colorbar", parent_name="parcoords.line", **kwarg tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.parcoords.line. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.parcoor + ds.line.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.parcoords.line.colorbar.tickformatstopdefault @@ -246,8 +246,9 @@ def __init__(self, plotly_name="colorbar", parent_name="parcoords.line", **kwarg tickwidth Sets the tick width (in px). title - plotly.graph_objects.parcoords.line.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.parcoords.line.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use parcoords.line.colorbar.title.font instead. diff --git a/packages/python/plotly/plotly/validators/pie/__init__.py b/packages/python/plotly/plotly/validators/pie/__init__.py index 8c9b003c6ac..b9b4c617f4b 100644 --- a/packages/python/plotly/plotly/validators/pie/__init__.py +++ b/packages/python/plotly/plotly/validators/pie/__init__.py @@ -493,8 +493,8 @@ def __init__(self, plotly_name="marker", parent_name="pie", **kwargs): Sets the source reference on plot.ly for colors . line - plotly.graph_objects.pie.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.pie.marker.Line` + instance or dict with compatible properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/pointcloud/__init__.py b/packages/python/plotly/plotly/validators/pointcloud/__init__.py index 87f183d3d48..3f90c27ec1f 100644 --- a/packages/python/plotly/plotly/validators/pointcloud/__init__.py +++ b/packages/python/plotly/plotly/validators/pointcloud/__init__.py @@ -359,8 +359,9 @@ def __init__(self, plotly_name="marker", parent_name="pointcloud", **kwargs): `blend` to `true` reduces zoom/pan speed if used with large numbers of points. border - plotly.graph_objects.pointcloud.marker.Border - instance or dict with compatible properties + :class:`plotly.graph_objects.pointcloud.marker. + Border` instance or dict with compatible + properties color Sets the marker fill color. It accepts a specific color.If the color is not fully opaque diff --git a/packages/python/plotly/plotly/validators/sankey/__init__.py b/packages/python/plotly/plotly/validators/sankey/__init__.py index 68a00ec95af..7236be0b863 100644 --- a/packages/python/plotly/plotly/validators/sankey/__init__.py +++ b/packages/python/plotly/plotly/validators/sankey/__init__.py @@ -197,8 +197,9 @@ def __init__(self, plotly_name="node", parent_name="sankey", **kwargs): `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.node.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.sankey.node.Hoverl + abel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -237,8 +238,8 @@ def __init__(self, plotly_name="node", parent_name="sankey", **kwargs): Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.node.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.sankey.node.Line` + instance or dict with compatible properties pad Sets the padding (in px) between the `nodes`. thickness @@ -319,9 +320,9 @@ def __init__(self, plotly_name="link", parent_name="sankey", **kwargs): by default, a translucent grey link will be used. colorscales - A tuple of - plotly.graph_objects.sankey.link.Colorscale - instances or dicts with compatible properties + A tuple of :class:`plotly.graph_objects.sankey. + link.Colorscale` instances or dicts with + compatible properties colorscaledefaults When used in a template (as layout.template.dat a.sankey.link.colorscaledefaults), sets the @@ -337,8 +338,9 @@ def __init__(self, plotly_name="link", parent_name="sankey", **kwargs): `none` is set, click and hover events are still fired. hoverlabel - plotly.graph_objects.sankey.link.Hoverlabel - instance or dict with compatible properties + :class:`plotly.graph_objects.sankey.link.Hoverl + abel` instance or dict with compatible + properties hovertemplate Template string used for rendering the information that appear on hover box. Note that @@ -377,8 +379,8 @@ def __init__(self, plotly_name="link", parent_name="sankey", **kwargs): Sets the source reference on plot.ly for label . line - plotly.graph_objects.sankey.link.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.sankey.link.Line` + instance or dict with compatible properties source An integer number `[0..nodes.length - 1]` that represents the source node. diff --git a/packages/python/plotly/plotly/validators/scatter/__init__.py b/packages/python/plotly/plotly/validators/scatter/__init__.py index 4aa4d5c362d..01758e38665 100644 --- a/packages/python/plotly/plotly/validators/scatter/__init__.py +++ b/packages/python/plotly/plotly/validators/scatter/__init__.py @@ -214,11 +214,13 @@ def __init__(self, plotly_name="unselected", parent_name="scatter", **kwargs): "data_docs", """ marker - plotly.graph_objects.scatter.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.unselected + .Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scatter.unselected.Textfon - t instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.unselected + .Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -527,11 +529,13 @@ def __init__(self, plotly_name="selected", parent_name="scatter", **kwargs): "data_docs", """ marker - plotly.graph_objects.scatter.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.M + arker` instance or dict with compatible + properties textfont - plotly.graph_objects.scatter.selected.Textfont - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.selected.T + extfont` instance or dict with compatible + properties """, ), **kwargs @@ -722,8 +726,9 @@ def __init__(self, plotly_name="marker", parent_name="scatter", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Col + orBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -744,11 +749,12 @@ def __init__(self, plotly_name="marker", parent_name="scatter", **kwargs): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatter.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Gra + dient` instance or dict with compatible + properties line - plotly.graph_objects.scatter.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.Lin + e` instance or dict with compatible properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. diff --git a/packages/python/plotly/plotly/validators/scatter/marker/__init__.py b/packages/python/plotly/plotly/validators/scatter/marker/__init__.py index 26a89cd4b7c..376d7d9db06 100644 --- a/packages/python/plotly/plotly/validators/scatter/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scatter/marker/__init__.py @@ -778,9 +778,9 @@ def __init__(self, plotly_name="colorbar", parent_name="scatter.marker", **kwarg tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter.marker. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.scatter + .marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatter.marker.colorbar.tickformatstopdefault @@ -827,8 +827,9 @@ def __init__(self, plotly_name="colorbar", parent_name="scatter.marker", **kwarg tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter.marker.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.scatter.marker.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use scatter.marker.colorbar.title.font instead. diff --git a/packages/python/plotly/plotly/validators/scatter3d/__init__.py b/packages/python/plotly/plotly/validators/scatter3d/__init__.py index 9b101d1dcfa..67b933591e4 100644 --- a/packages/python/plotly/plotly/validators/scatter3d/__init__.py +++ b/packages/python/plotly/plotly/validators/scatter3d/__init__.py @@ -477,14 +477,17 @@ def __init__(self, plotly_name="projection", parent_name="scatter3d", **kwargs): "data_docs", """ x - plotly.graph_objects.scatter3d.projection.X - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projecti + on.X` instance or dict with compatible + properties y - plotly.graph_objects.scatter3d.projection.Y - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projecti + on.Y` instance or dict with compatible + properties z - plotly.graph_objects.scatter3d.projection.Z - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.projecti + on.Z` instance or dict with compatible + properties """, ), **kwargs @@ -632,8 +635,9 @@ def __init__(self, plotly_name="marker", parent_name="scatter3d", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -654,8 +658,9 @@ def __init__(self, plotly_name="marker", parent_name="scatter3d", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatter3d.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.marker.L + ine` instance or dict with compatible + properties opacity Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar @@ -769,8 +774,9 @@ def __init__(self, plotly_name="line", parent_name="scatter3d", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatter3d.line.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.Col + orBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The diff --git a/packages/python/plotly/plotly/validators/scatter3d/line/__init__.py b/packages/python/plotly/plotly/validators/scatter3d/line/__init__.py index 308896901ea..b7e0faf6bb5 100644 --- a/packages/python/plotly/plotly/validators/scatter3d/line/__init__.py +++ b/packages/python/plotly/plotly/validators/scatter3d/line/__init__.py @@ -229,9 +229,9 @@ def __init__(self, plotly_name="colorbar", parent_name="scatter3d.line", **kwarg tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.line. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.scatter + 3d.line.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatter3d.line.colorbar.tickformatstopdefault @@ -278,8 +278,9 @@ def __init__(self, plotly_name="colorbar", parent_name="scatter3d.line", **kwarg tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.line.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.scatter3d.line.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use scatter3d.line.colorbar.title.font instead. diff --git a/packages/python/plotly/plotly/validators/scatter3d/marker/__init__.py b/packages/python/plotly/plotly/validators/scatter3d/marker/__init__.py index 3b899f0fdaf..c427b26ea79 100644 --- a/packages/python/plotly/plotly/validators/scatter3d/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scatter3d/marker/__init__.py @@ -443,9 +443,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatter3d.marke - r.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + 3d.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatter3d.marker.colorbar.tickformatstopdefau @@ -492,8 +492,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatter3d.marker.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.scatter3d.marker.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/scattercarpet/__init__.py b/packages/python/plotly/plotly/validators/scattercarpet/__init__.py index 8d96b7c5a78..cc9638d63f4 100644 --- a/packages/python/plotly/plotly/validators/scattercarpet/__init__.py +++ b/packages/python/plotly/plotly/validators/scattercarpet/__init__.py @@ -56,13 +56,13 @@ def __init__(self, plotly_name="unselected", parent_name="scattercarpet", **kwar "data_docs", """ marker - plotly.graph_objects.scattercarpet.unselected.M - arker instance or dict with compatible + :class:`plotly.graph_objects.scattercarpet.unse + lected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scattercarpet.unselected.T - extfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scattercarpet.unse + lected.Textfont` instance or dict with + compatible properties """, ), **kwargs @@ -323,11 +323,12 @@ def __init__(self, plotly_name="selected", parent_name="scattercarpet", **kwargs "data_docs", """ marker - plotly.graph_objects.scattercarpet.selected.Mar - ker instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.sele + cted.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattercarpet.selected.Tex - tfont instance or dict with compatible + :class:`plotly.graph_objects.scattercarpet.sele + cted.Textfont` instance or dict with compatible properties """, ), @@ -476,8 +477,9 @@ def __init__(self, plotly_name="marker", parent_name="scattercarpet", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattercarpet.marker.Color - Bar instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.mark + er.ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -498,11 +500,13 @@ def __init__(self, plotly_name="marker", parent_name="scattercarpet", **kwargs): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattercarpet.marker.Gradi - ent instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.mark + er.Gradient` instance or dict with compatible + properties line - plotly.graph_objects.scattercarpet.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattercarpet.mark + er.Line` instance or dict with compatible + properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. diff --git a/packages/python/plotly/plotly/validators/scattercarpet/marker/__init__.py b/packages/python/plotly/plotly/validators/scattercarpet/marker/__init__.py index 4ea8155b4c6..9fe8cf77540 100644 --- a/packages/python/plotly/plotly/validators/scattercarpet/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scattercarpet/marker/__init__.py @@ -802,9 +802,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattercarpet.m - arker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + carpet.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattercarpet.marker.colorbar.tickformatstopd @@ -851,9 +851,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattercarpet.marker.color - bar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scattercarpet.mark + er.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scattercarpet.marker.colorbar.title.font diff --git a/packages/python/plotly/plotly/validators/scattergeo/__init__.py b/packages/python/plotly/plotly/validators/scattergeo/__init__.py index efb66a12cc4..c1c7534ef64 100644 --- a/packages/python/plotly/plotly/validators/scattergeo/__init__.py +++ b/packages/python/plotly/plotly/validators/scattergeo/__init__.py @@ -26,11 +26,12 @@ def __init__(self, plotly_name="unselected", parent_name="scattergeo", **kwargs) "data_docs", """ marker - plotly.graph_objects.scattergeo.unselected.Mark - er instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.unselec + ted.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergeo.unselected.Text - font instance or dict with compatible + :class:`plotly.graph_objects.scattergeo.unselec + ted.Textfont` instance or dict with compatible properties """, ), @@ -288,11 +289,13 @@ def __init__(self, plotly_name="selected", parent_name="scattergeo", **kwargs): "data_docs", """ marker - plotly.graph_objects.scattergeo.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selecte + d.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergeo.selected.Textfo - nt instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.selecte + d.Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -440,8 +443,9 @@ def __init__(self, plotly_name="marker", parent_name="scattergeo", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergeo.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker. + ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -462,11 +466,13 @@ def __init__(self, plotly_name="marker", parent_name="scattergeo", **kwargs): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scattergeo.marker.Gradient - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker. + Gradient` instance or dict with compatible + properties line - plotly.graph_objects.scattergeo.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergeo.marker. + Line` instance or dict with compatible + properties opacity Sets the marker opacity. opacitysrc diff --git a/packages/python/plotly/plotly/validators/scattergeo/marker/__init__.py b/packages/python/plotly/plotly/validators/scattergeo/marker/__init__.py index 68ecbf91d51..65deaede991 100644 --- a/packages/python/plotly/plotly/validators/scattergeo/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scattergeo/marker/__init__.py @@ -779,9 +779,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergeo.mark - er.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + geo.marker.colorbar.Tickformatstop` instances + or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattergeo.marker.colorbar.tickformatstopdefa @@ -828,9 +828,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergeo.marker.colorbar - .Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scattergeo.marker. + colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scattergeo.marker.colorbar.title.font instead. diff --git a/packages/python/plotly/plotly/validators/scattergl/__init__.py b/packages/python/plotly/plotly/validators/scattergl/__init__.py index 8f1ad3f82ed..16f79920b88 100644 --- a/packages/python/plotly/plotly/validators/scattergl/__init__.py +++ b/packages/python/plotly/plotly/validators/scattergl/__init__.py @@ -210,11 +210,13 @@ def __init__(self, plotly_name="unselected", parent_name="scattergl", **kwargs): "data_docs", """ marker - plotly.graph_objects.scattergl.unselected.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselect + ed.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergl.unselected.Textf - ont instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.unselect + ed.Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -469,11 +471,13 @@ def __init__(self, plotly_name="selected", parent_name="scattergl", **kwargs): "data_docs", """ marker - plotly.graph_objects.scattergl.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.selected + .Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scattergl.selected.Textfon - t instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.selected + .Textfont` instance or dict with compatible + properties """, ), **kwargs @@ -621,8 +625,9 @@ def __init__(self, plotly_name="marker", parent_name="scattergl", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattergl.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.C + olorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -643,8 +648,9 @@ def __init__(self, plotly_name="marker", parent_name="scattergl", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.scattergl.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scattergl.marker.L + ine` instance or dict with compatible + properties opacity Sets the marker opacity. opacitysrc diff --git a/packages/python/plotly/plotly/validators/scattergl/marker/__init__.py b/packages/python/plotly/plotly/validators/scattergl/marker/__init__.py index caf0ffdffae..8a07bdf33f2 100644 --- a/packages/python/plotly/plotly/validators/scattergl/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scattergl/marker/__init__.py @@ -738,9 +738,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattergl.marke - r.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + gl.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattergl.marker.colorbar.tickformatstopdefau @@ -787,8 +787,8 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattergl.marker.colorbar. - Title instance or dict with compatible + :class:`plotly.graph_objects.scattergl.marker.c + olorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/scattermapbox/__init__.py b/packages/python/plotly/plotly/validators/scattermapbox/__init__.py index 12908dc38bc..dfb336a83f4 100644 --- a/packages/python/plotly/plotly/validators/scattermapbox/__init__.py +++ b/packages/python/plotly/plotly/validators/scattermapbox/__init__.py @@ -26,8 +26,8 @@ def __init__(self, plotly_name="unselected", parent_name="scattermapbox", **kwar "data_docs", """ marker - plotly.graph_objects.scattermapbox.unselected.M - arker instance or dict with compatible + :class:`plotly.graph_objects.scattermapbox.unse + lected.Marker` instance or dict with compatible properties """, ), @@ -279,8 +279,9 @@ def __init__(self, plotly_name="selected", parent_name="scattermapbox", **kwargs "data_docs", """ marker - plotly.graph_objects.scattermapbox.selected.Mar - ker instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.sele + cted.Marker` instance or dict with compatible + properties """, ), **kwargs @@ -428,8 +429,9 @@ def __init__(self, plotly_name="marker", parent_name="scattermapbox", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scattermapbox.marker.Color - Bar instance or dict with compatible properties + :class:`plotly.graph_objects.scattermapbox.mark + er.ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The diff --git a/packages/python/plotly/plotly/validators/scattermapbox/marker/__init__.py b/packages/python/plotly/plotly/validators/scattermapbox/marker/__init__.py index c39968a189f..36b73c23cca 100644 --- a/packages/python/plotly/plotly/validators/scattermapbox/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scattermapbox/marker/__init__.py @@ -355,9 +355,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scattermapbox.m - arker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + mapbox.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scattermapbox.marker.colorbar.tickformatstopd @@ -404,9 +404,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scattermapbox.marker.color - bar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scattermapbox.mark + er.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scattermapbox.marker.colorbar.title.font diff --git a/packages/python/plotly/plotly/validators/scatterpolar/__init__.py b/packages/python/plotly/plotly/validators/scatterpolar/__init__.py index 1fe6983656a..b1ac046760d 100644 --- a/packages/python/plotly/plotly/validators/scatterpolar/__init__.py +++ b/packages/python/plotly/plotly/validators/scatterpolar/__init__.py @@ -26,13 +26,13 @@ def __init__(self, plotly_name="unselected", parent_name="scatterpolar", **kwarg "data_docs", """ marker - plotly.graph_objects.scatterpolar.unselected.Ma - rker instance or dict with compatible + :class:`plotly.graph_objects.scatterpolar.unsel + ected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolar.unselected.Te - xtfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolar.unsel + ected.Textfont` instance or dict with + compatible properties """, ), **kwargs @@ -365,11 +365,12 @@ def __init__(self, plotly_name="selected", parent_name="scatterpolar", **kwargs) "data_docs", """ marker - plotly.graph_objects.scatterpolar.selected.Mark - er instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.selec + ted.Marker` instance or dict with compatible + properties textfont - plotly.graph_objects.scatterpolar.selected.Text - font instance or dict with compatible + :class:`plotly.graph_objects.scatterpolar.selec + ted.Textfont` instance or dict with compatible properties """, ), @@ -560,8 +561,9 @@ def __init__(self, plotly_name="marker", parent_name="scatterpolar", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolar.marker.ColorB - ar instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marke + r.ColorBar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -582,11 +584,13 @@ def __init__(self, plotly_name="marker", parent_name="scatterpolar", **kwargs): Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterpolar.marker.Gradie - nt instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marke + r.Gradient` instance or dict with compatible + properties line - plotly.graph_objects.scatterpolar.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolar.marke + r.Line` instance or dict with compatible + properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. diff --git a/packages/python/plotly/plotly/validators/scatterpolar/marker/__init__.py b/packages/python/plotly/plotly/validators/scatterpolar/marker/__init__.py index 384bece97b1..5f20c59c413 100644 --- a/packages/python/plotly/plotly/validators/scatterpolar/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scatterpolar/marker/__init__.py @@ -798,9 +798,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolar.ma - rker.colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + polar.marker.colorbar.Tickformatstop` instances + or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatterpolar.marker.colorbar.tickformatstopde @@ -847,9 +847,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolar.marker.colorb - ar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolar.marke + r.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scatterpolar.marker.colorbar.title.font diff --git a/packages/python/plotly/plotly/validators/scatterpolargl/__init__.py b/packages/python/plotly/plotly/validators/scatterpolargl/__init__.py index 4b4bd145d9f..04949ef1fdf 100644 --- a/packages/python/plotly/plotly/validators/scatterpolargl/__init__.py +++ b/packages/python/plotly/plotly/validators/scatterpolargl/__init__.py @@ -28,13 +28,13 @@ def __init__( "data_docs", """ marker - plotly.graph_objects.scatterpolargl.unselected. - Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.uns + elected.Marker` instance or dict with + compatible properties textfont - plotly.graph_objects.scatterpolargl.unselected. - Textfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.uns + elected.Textfont` instance or dict with + compatible properties """, ), **kwargs @@ -371,13 +371,13 @@ def __init__(self, plotly_name="selected", parent_name="scatterpolargl", **kwarg "data_docs", """ marker - plotly.graph_objects.scatterpolargl.selected.Ma - rker instance or dict with compatible + :class:`plotly.graph_objects.scatterpolargl.sel + ected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterpolargl.selected.Te - xtfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.sel + ected.Textfont` instance or dict with + compatible properties """, ), **kwargs @@ -567,8 +567,8 @@ def __init__(self, plotly_name="marker", parent_name="scatterpolargl", **kwargs) color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterpolargl.marker.Colo - rBar instance or dict with compatible + :class:`plotly.graph_objects.scatterpolargl.mar + ker.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in @@ -590,8 +590,9 @@ def __init__(self, plotly_name="marker", parent_name="scatterpolargl", **kwargs) Sets the source reference on plot.ly for color . line - plotly.graph_objects.scatterpolargl.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterpolargl.mar + ker.Line` instance or dict with compatible + properties opacity Sets the marker opacity. opacitysrc diff --git a/packages/python/plotly/plotly/validators/scatterpolargl/marker/__init__.py b/packages/python/plotly/plotly/validators/scatterpolargl/marker/__init__.py index c648f65ff88..2d37e19a24e 100644 --- a/packages/python/plotly/plotly/validators/scatterpolargl/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scatterpolargl/marker/__init__.py @@ -752,9 +752,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterpolargl. - marker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + polargl.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatterpolargl.marker.colorbar.tickformatstop @@ -801,9 +801,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterpolargl.marker.colo - rbar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterpolargl.mar + ker.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scatterpolargl.marker.colorbar.title.font diff --git a/packages/python/plotly/plotly/validators/scatterternary/__init__.py b/packages/python/plotly/plotly/validators/scatterternary/__init__.py index bf59e22ccd4..8ece80e1ac9 100644 --- a/packages/python/plotly/plotly/validators/scatterternary/__init__.py +++ b/packages/python/plotly/plotly/validators/scatterternary/__init__.py @@ -28,13 +28,13 @@ def __init__( "data_docs", """ marker - plotly.graph_objects.scatterternary.unselected. - Marker instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.uns + elected.Marker` instance or dict with + compatible properties textfont - plotly.graph_objects.scatterternary.unselected. - Textfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.uns + elected.Textfont` instance or dict with + compatible properties """, ), **kwargs @@ -329,13 +329,13 @@ def __init__(self, plotly_name="selected", parent_name="scatterternary", **kwarg "data_docs", """ marker - plotly.graph_objects.scatterternary.selected.Ma - rker instance or dict with compatible + :class:`plotly.graph_objects.scatterternary.sel + ected.Marker` instance or dict with compatible properties textfont - plotly.graph_objects.scatterternary.selected.Te - xtfont instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.sel + ected.Textfont` instance or dict with + compatible properties """, ), **kwargs @@ -483,8 +483,8 @@ def __init__(self, plotly_name="marker", parent_name="scatterternary", **kwargs) color scales can be linked to the same color axis. colorbar - plotly.graph_objects.scatterternary.marker.Colo - rBar instance or dict with compatible + :class:`plotly.graph_objects.scatterternary.mar + ker.ColorBar` instance or dict with compatible properties colorscale Sets the colorscale. Has an effect only if in @@ -506,12 +506,13 @@ def __init__(self, plotly_name="marker", parent_name="scatterternary", **kwargs) Sets the source reference on plot.ly for color . gradient - plotly.graph_objects.scatterternary.marker.Grad - ient instance or dict with compatible + :class:`plotly.graph_objects.scatterternary.mar + ker.Gradient` instance or dict with compatible properties line - plotly.graph_objects.scatterternary.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.scatterternary.mar + ker.Line` instance or dict with compatible + properties maxdisplayed Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit. diff --git a/packages/python/plotly/plotly/validators/scatterternary/marker/__init__.py b/packages/python/plotly/plotly/validators/scatterternary/marker/__init__.py index 7d1ed55a59f..43d341bf04b 100644 --- a/packages/python/plotly/plotly/validators/scatterternary/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/scatterternary/marker/__init__.py @@ -802,9 +802,9 @@ def __init__( tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.scatterternary. - marker.colorbar.Tickformatstop instances or - dicts with compatible properties + A tuple of :class:`plotly.graph_objects.scatter + ternary.marker.colorbar.Tickformatstop` + instances or dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.scatterternary.marker.colorbar.tickformatstop @@ -851,9 +851,9 @@ def __init__( tickwidth Sets the tick width (in px). title - plotly.graph_objects.scatterternary.marker.colo - rbar.Title instance or dict with compatible - properties + :class:`plotly.graph_objects.scatterternary.mar + ker.colorbar.Title` instance or dict with + compatible properties titlefont Deprecated: Please use scatterternary.marker.colorbar.title.font diff --git a/packages/python/plotly/plotly/validators/splom/__init__.py b/packages/python/plotly/plotly/validators/splom/__init__.py index 4c1b9735b96..60f2df7ee6b 100644 --- a/packages/python/plotly/plotly/validators/splom/__init__.py +++ b/packages/python/plotly/plotly/validators/splom/__init__.py @@ -72,8 +72,9 @@ def __init__(self, plotly_name="unselected", parent_name="splom", **kwargs): "data_docs", """ marker - plotly.graph_objects.splom.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.unselected.M + arker` instance or dict with compatible + properties """, ), **kwargs @@ -233,8 +234,9 @@ def __init__(self, plotly_name="selected", parent_name="splom", **kwargs): "data_docs", """ marker - plotly.graph_objects.splom.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.selected.Mar + ker` instance or dict with compatible + properties """, ), **kwargs @@ -366,8 +368,9 @@ def __init__(self, plotly_name="marker", parent_name="splom", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.splom.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.Color + Bar` instance or dict with compatible + properties colorscale Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The @@ -388,8 +391,8 @@ def __init__(self, plotly_name="marker", parent_name="splom", **kwargs): Sets the source reference on plot.ly for color . line - plotly.graph_objects.splom.marker.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.Line` + instance or dict with compatible properties opacity Sets the marker opacity. opacitysrc @@ -655,8 +658,8 @@ def __init__(self, plotly_name="dimensions", parent_name="splom", **kwargs): "data_docs", """ axis - plotly.graph_objects.splom.dimension.Axis - instance or dict with compatible properties + :class:`plotly.graph_objects.splom.dimension.Ax + is` instance or dict with compatible properties label Sets the label corresponding to this splom dimension. diff --git a/packages/python/plotly/plotly/validators/splom/marker/__init__.py b/packages/python/plotly/plotly/validators/splom/marker/__init__.py index 3a527537cf3..f9f9bd8cde2 100644 --- a/packages/python/plotly/plotly/validators/splom/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/splom/marker/__init__.py @@ -724,9 +724,9 @@ def __init__(self, plotly_name="colorbar", parent_name="splom.marker", **kwargs) tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.splom.marker.co - lorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.splom.m + arker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.splom.marker.colorbar.tickformatstopdefaults) @@ -773,8 +773,9 @@ def __init__(self, plotly_name="colorbar", parent_name="splom.marker", **kwargs) tickwidth Sets the tick width (in px). title - plotly.graph_objects.splom.marker.colorbar.Titl - e instance or dict with compatible properties + :class:`plotly.graph_objects.splom.marker.color + bar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use splom.marker.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/streamtube/__init__.py b/packages/python/plotly/plotly/validators/streamtube/__init__.py index 5ca22eb1de1..8605835c146 100644 --- a/packages/python/plotly/plotly/validators/streamtube/__init__.py +++ b/packages/python/plotly/plotly/validators/streamtube/__init__.py @@ -853,9 +853,9 @@ def __init__(self, plotly_name="colorbar", parent_name="streamtube", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.streamtube.colo - rbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.streamt + ube.colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.streamtube.colorbar.tickformatstopdefaults), @@ -901,8 +901,9 @@ def __init__(self, plotly_name="colorbar", parent_name="streamtube", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.streamtube.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.streamtube.colorba + r.Title` instance or dict with compatible + properties titlefont Deprecated: Please use streamtube.colorbar.title.font instead. Sets diff --git a/packages/python/plotly/plotly/validators/sunburst/__init__.py b/packages/python/plotly/plotly/validators/sunburst/__init__.py index 4cbaac4a309..2512eee6914 100644 --- a/packages/python/plotly/plotly/validators/sunburst/__init__.py +++ b/packages/python/plotly/plotly/validators/sunburst/__init__.py @@ -435,8 +435,9 @@ def __init__(self, plotly_name="marker", parent_name="sunburst", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.sunburst.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.Co + lorBar` instance or dict with compatible + properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is @@ -461,8 +462,8 @@ def __init__(self, plotly_name="marker", parent_name="sunburst", **kwargs): Sets the source reference on plot.ly for colors . line - plotly.graph_objects.sunburst.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.sunburst.marker.Li + ne` instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical diff --git a/packages/python/plotly/plotly/validators/sunburst/marker/__init__.py b/packages/python/plotly/plotly/validators/sunburst/marker/__init__.py index 00ffa55f0ab..ca59bfb40d6 100644 --- a/packages/python/plotly/plotly/validators/sunburst/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/sunburst/marker/__init__.py @@ -245,9 +245,9 @@ def __init__(self, plotly_name="colorbar", parent_name="sunburst.marker", **kwar tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.sunburst.marker - .colorbar.Tickformatstop instances or dicts - with compatible properties + A tuple of :class:`plotly.graph_objects.sunburs + t.marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.sunburst.marker.colorbar.tickformatstopdefaul @@ -294,8 +294,8 @@ def __init__(self, plotly_name="colorbar", parent_name="sunburst.marker", **kwar tickwidth Sets the tick width (in px). title - plotly.graph_objects.sunburst.marker.colorbar.T - itle instance or dict with compatible + :class:`plotly.graph_objects.sunburst.marker.co + lorbar.Title` instance or dict with compatible properties titlefont Deprecated: Please use diff --git a/packages/python/plotly/plotly/validators/surface/__init__.py b/packages/python/plotly/plotly/validators/surface/__init__.py index d6faf02c65b..912acb02872 100644 --- a/packages/python/plotly/plotly/validators/surface/__init__.py +++ b/packages/python/plotly/plotly/validators/surface/__init__.py @@ -732,14 +732,14 @@ def __init__(self, plotly_name="contours", parent_name="surface", **kwargs): "data_docs", """ x - plotly.graph_objects.surface.contours.X - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.X + ` instance or dict with compatible properties y - plotly.graph_objects.surface.contours.Y - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Y + ` instance or dict with compatible properties z - plotly.graph_objects.surface.contours.Z - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.Z + ` instance or dict with compatible properties """, ), **kwargs @@ -913,9 +913,9 @@ def __init__(self, plotly_name="colorbar", parent_name="surface", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.surface.colorba - r.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.surface + .colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.surface.colorbar.tickformatstopdefaults), @@ -961,8 +961,9 @@ def __init__(self, plotly_name="colorbar", parent_name="surface", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.surface.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.colorbar.T + itle` instance or dict with compatible + properties titlefont Deprecated: Please use surface.colorbar.title.font instead. Sets this diff --git a/packages/python/plotly/plotly/validators/surface/contours/__init__.py b/packages/python/plotly/plotly/validators/surface/contours/__init__.py index c6594de259a..1713dea7671 100644 --- a/packages/python/plotly/plotly/validators/surface/contours/__init__.py +++ b/packages/python/plotly/plotly/validators/surface/contours/__init__.py @@ -25,8 +25,9 @@ def __init__(self, plotly_name="z", parent_name="surface.contours", **kwargs): Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.z.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.z + .Project` instance or dict with compatible + properties show Determines whether or not contour lines about the z dimension are drawn. @@ -75,8 +76,9 @@ def __init__(self, plotly_name="y", parent_name="surface.contours", **kwargs): Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.y.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.y + .Project` instance or dict with compatible + properties show Determines whether or not contour lines about the y dimension are drawn. @@ -125,8 +127,9 @@ def __init__(self, plotly_name="x", parent_name="surface.contours", **kwargs): Sets the width of the highlighted contour lines. project - plotly.graph_objects.surface.contours.x.Project - instance or dict with compatible properties + :class:`plotly.graph_objects.surface.contours.x + .Project` instance or dict with compatible + properties show Determines whether or not contour lines about the x dimension are drawn. diff --git a/packages/python/plotly/plotly/validators/table/__init__.py b/packages/python/plotly/plotly/validators/table/__init__.py index 667b11f27e2..2bfd8293fd2 100644 --- a/packages/python/plotly/plotly/validators/table/__init__.py +++ b/packages/python/plotly/plotly/validators/table/__init__.py @@ -245,11 +245,11 @@ def __init__(self, plotly_name="header", parent_name="table", **kwargs): Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.header.Fill instance - or dict with compatible properties + :class:`plotly.graph_objects.table.header.Fill` + instance or dict with compatible properties font - plotly.graph_objects.table.header.Font instance - or dict with compatible properties + :class:`plotly.graph_objects.table.header.Font` + instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to @@ -262,8 +262,8 @@ def __init__(self, plotly_name="header", parent_name="table", **kwargs): height The height of cells. line - plotly.graph_objects.table.header.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.table.header.Line` + instance or dict with compatible properties prefix Prefix for cell values. prefixsrc @@ -427,11 +427,11 @@ def __init__(self, plotly_name="cells", parent_name="table", **kwargs): Sets the source reference on plot.ly for align . fill - plotly.graph_objects.table.cells.Fill instance - or dict with compatible properties + :class:`plotly.graph_objects.table.cells.Fill` + instance or dict with compatible properties font - plotly.graph_objects.table.cells.Font instance - or dict with compatible properties + :class:`plotly.graph_objects.table.cells.Font` + instance or dict with compatible properties format Sets the cell value formatting rule using d3 formatting mini-language which is similar to @@ -444,8 +444,8 @@ def __init__(self, plotly_name="cells", parent_name="table", **kwargs): height The height of cells. line - plotly.graph_objects.table.cells.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.table.cells.Line` + instance or dict with compatible properties prefix Prefix for cell values. prefixsrc diff --git a/packages/python/plotly/plotly/validators/treemap/__init__.py b/packages/python/plotly/plotly/validators/treemap/__init__.py index da0fa50e6dc..4d67e5a3762 100644 --- a/packages/python/plotly/plotly/validators/treemap/__init__.py +++ b/packages/python/plotly/plotly/validators/treemap/__init__.py @@ -540,8 +540,9 @@ def __init__(self, plotly_name="marker", parent_name="treemap", **kwargs): color scales can be linked to the same color axis. colorbar - plotly.graph_objects.treemap.marker.ColorBar - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Col + orBar` instance or dict with compatible + properties colors Sets the color of each sector of this trace. If not specified, the default trace color set is @@ -577,11 +578,11 @@ def __init__(self, plotly_name="marker", parent_name="treemap", **kwargs): colors while the leaves are faded towards the background color. line - plotly.graph_objects.treemap.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Lin + e` instance or dict with compatible properties pad - plotly.graph_objects.treemap.marker.Pad - instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.Pad + ` instance or dict with compatible properties reversescale Reverses the color mapping if true. Has an effect only if colorsis set to a numerical diff --git a/packages/python/plotly/plotly/validators/treemap/marker/__init__.py b/packages/python/plotly/plotly/validators/treemap/marker/__init__.py index c0a06b1630f..27e9e68ec1e 100644 --- a/packages/python/plotly/plotly/validators/treemap/marker/__init__.py +++ b/packages/python/plotly/plotly/validators/treemap/marker/__init__.py @@ -282,9 +282,9 @@ def __init__(self, plotly_name="colorbar", parent_name="treemap.marker", **kwarg tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.treemap.marker. - colorbar.Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.treemap + .marker.colorbar.Tickformatstop` instances or + dicts with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.treemap.marker.colorbar.tickformatstopdefault @@ -331,8 +331,9 @@ def __init__(self, plotly_name="colorbar", parent_name="treemap.marker", **kwarg tickwidth Sets the tick width (in px). title - plotly.graph_objects.treemap.marker.colorbar.Ti - tle instance or dict with compatible properties + :class:`plotly.graph_objects.treemap.marker.col + orbar.Title` instance or dict with compatible + properties titlefont Deprecated: Please use treemap.marker.colorbar.title.font instead. diff --git a/packages/python/plotly/plotly/validators/violin/__init__.py b/packages/python/plotly/plotly/validators/violin/__init__.py index c3506e70f80..2daa13bc0a3 100644 --- a/packages/python/plotly/plotly/validators/violin/__init__.py +++ b/packages/python/plotly/plotly/validators/violin/__init__.py @@ -155,8 +155,9 @@ def __init__(self, plotly_name="unselected", parent_name="violin", **kwargs): "data_docs", """ marker - plotly.graph_objects.violin.unselected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.violin.unselected. + Marker` instance or dict with compatible + properties """, ), **kwargs @@ -339,8 +340,9 @@ def __init__(self, plotly_name="selected", parent_name="violin", **kwargs): "data_docs", """ marker - plotly.graph_objects.violin.selected.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.violin.selected.Ma + rker` instance or dict with compatible + properties """, ), **kwargs @@ -545,8 +547,8 @@ def __init__(self, plotly_name="marker", parent_name="violin", **kwargs): and min values of the array or relative to `marker.cmin` and `marker.cmax` if set. line - plotly.graph_objects.violin.marker.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.violin.marker.Line + ` instance or dict with compatible properties opacity Sets the marker opacity. outliercolor @@ -862,8 +864,8 @@ def __init__(self, plotly_name="box", parent_name="violin", **kwargs): fillcolor Sets the inner box plot fill color. line - plotly.graph_objects.violin.box.Line instance - or dict with compatible properties + :class:`plotly.graph_objects.violin.box.Line` + instance or dict with compatible properties visible Determines if an miniature box plot is drawn inside the violins. diff --git a/packages/python/plotly/plotly/validators/volume/__init__.py b/packages/python/plotly/plotly/validators/volume/__init__.py index 67f69d8a3ea..b9e164e7d97 100644 --- a/packages/python/plotly/plotly/validators/volume/__init__.py +++ b/packages/python/plotly/plotly/validators/volume/__init__.py @@ -295,14 +295,14 @@ def __init__(self, plotly_name="slices", parent_name="volume", **kwargs): "data_docs", """ x - plotly.graph_objects.volume.slices.X instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.slices.X` + instance or dict with compatible properties y - plotly.graph_objects.volume.slices.Y instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.slices.Y` + instance or dict with compatible properties z - plotly.graph_objects.volume.slices.Z instance - or dict with compatible properties + :class:`plotly.graph_objects.volume.slices.Z` + instance or dict with compatible properties """, ), **kwargs @@ -940,9 +940,9 @@ def __init__(self, plotly_name="colorbar", parent_name="volume", **kwargs): tickformat "%H~%M~%S.%2f" would display "09~15~23.46" tickformatstops - A tuple of plotly.graph_objects.volume.colorbar - .Tickformatstop instances or dicts with - compatible properties + A tuple of :class:`plotly.graph_objects.volume. + colorbar.Tickformatstop` instances or dicts + with compatible properties tickformatstopdefaults When used in a template (as layout.template.dat a.volume.colorbar.tickformatstopdefaults), sets @@ -988,8 +988,9 @@ def __init__(self, plotly_name="colorbar", parent_name="volume", **kwargs): tickwidth Sets the tick width (in px). title - plotly.graph_objects.volume.colorbar.Title - instance or dict with compatible properties + :class:`plotly.graph_objects.volume.colorbar.Ti + tle` instance or dict with compatible + properties titlefont Deprecated: Please use volume.colorbar.title.font instead. Sets this @@ -1119,14 +1120,14 @@ def __init__(self, plotly_name="caps", parent_name="volume", **kwargs): "data_docs", """ x - plotly.graph_objects.volume.caps.X instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.caps.X` + instance or dict with compatible properties y - plotly.graph_objects.volume.caps.Y instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.caps.Y` + instance or dict with compatible properties z - plotly.graph_objects.volume.caps.Z instance or - dict with compatible properties + :class:`plotly.graph_objects.volume.caps.Z` + instance or dict with compatible properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/waterfall/__init__.py b/packages/python/plotly/plotly/validators/waterfall/__init__.py index d908784c43a..93de9b67b74 100644 --- a/packages/python/plotly/plotly/validators/waterfall/__init__.py +++ b/packages/python/plotly/plotly/validators/waterfall/__init__.py @@ -198,8 +198,9 @@ def __init__(self, plotly_name="totals", parent_name="waterfall", **kwargs): "data_docs", """ marker - plotly.graph_objects.waterfall.totals.Marker - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.M + arker` instance or dict with compatible + properties """, ), **kwargs @@ -716,8 +717,9 @@ def __init__(self, plotly_name="increasing", parent_name="waterfall", **kwargs): "data_docs", """ marker - plotly.graph_objects.waterfall.increasing.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.increasi + ng.Marker` instance or dict with compatible + properties """, ), **kwargs @@ -939,8 +941,9 @@ def __init__(self, plotly_name="decreasing", parent_name="waterfall", **kwargs): "data_docs", """ marker - plotly.graph_objects.waterfall.decreasing.Marke - r instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.decreasi + ng.Marker` instance or dict with compatible + properties """, ), **kwargs @@ -1003,8 +1006,9 @@ def __init__(self, plotly_name="connector", parent_name="waterfall", **kwargs): "data_docs", """ line - plotly.graph_objects.waterfall.connector.Line - instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.connecto + r.Line` instance or dict with compatible + properties mode Sets the shape of connector lines. visible diff --git a/packages/python/plotly/plotly/validators/waterfall/decreasing/__init__.py b/packages/python/plotly/plotly/validators/waterfall/decreasing/__init__.py index f33689a4759..890fc67a9cc 100644 --- a/packages/python/plotly/plotly/validators/waterfall/decreasing/__init__.py +++ b/packages/python/plotly/plotly/validators/waterfall/decreasing/__init__.py @@ -15,9 +15,9 @@ def __init__( color Sets the marker color of all decreasing values. line - plotly.graph_objects.waterfall.decreasing.marke - r.Line instance or dict with compatible - properties + :class:`plotly.graph_objects.waterfall.decreasi + ng.marker.Line` instance or dict with + compatible properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/waterfall/increasing/__init__.py b/packages/python/plotly/plotly/validators/waterfall/increasing/__init__.py index 9768111361c..f5a972b8e9a 100644 --- a/packages/python/plotly/plotly/validators/waterfall/increasing/__init__.py +++ b/packages/python/plotly/plotly/validators/waterfall/increasing/__init__.py @@ -15,9 +15,9 @@ def __init__( color Sets the marker color of all increasing values. line - plotly.graph_objects.waterfall.increasing.marke - r.Line instance or dict with compatible - properties + :class:`plotly.graph_objects.waterfall.increasi + ng.marker.Line` instance or dict with + compatible properties """, ), **kwargs diff --git a/packages/python/plotly/plotly/validators/waterfall/totals/__init__.py b/packages/python/plotly/plotly/validators/waterfall/totals/__init__.py index c106e299760..64687ae98f7 100644 --- a/packages/python/plotly/plotly/validators/waterfall/totals/__init__.py +++ b/packages/python/plotly/plotly/validators/waterfall/totals/__init__.py @@ -14,8 +14,9 @@ def __init__(self, plotly_name="marker", parent_name="waterfall.totals", **kwarg Sets the marker color of all intermediate sums and total values. line - plotly.graph_objects.waterfall.totals.marker.Li - ne instance or dict with compatible properties + :class:`plotly.graph_objects.waterfall.totals.m + arker.Line` instance or dict with compatible + properties """, ), **kwargs