| PyPI Downloads |
@@ -26,7 +34,7 @@
## Quickstart
-`pip install plotly==4.5.3`
+`pip install plotly==4.5.4`
Inside [Jupyter notebook](https://jupyter.org/install) (installable with `pip install "notebook>=5.3" "ipywidgets>=7.2"`):
@@ -45,7 +53,7 @@ Read about what's new in [plotly.py v4](https://medium.com/plotly/plotly-py-4-0-
## Overview
-[plotly.py](https://plot.ly/d3-js-for-python-and-pandas-charts/) is an interactive, open-source, and browser-based graphing library for Python :sparkles:
+[plotly.py](https://plot.ly/python) is an interactive, open-source, and browser-based graphing library for Python :sparkles:
Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is a high-level, declarative charting library. plotly.js ships with over 30 chart types, including scientific charts, 3D graphs, statistical charts, SVG maps, financial charts, and more.
@@ -61,12 +69,12 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
---
- [Online Documentation](https://plot.ly/python)
-- [Contributing](contributing.md)
+- [Contributing to plotly](contributing.md)
- [Changelog](CHANGELOG.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Version 4 Migration Guide](https://plot.ly/python/next/v4-migration/)
- [New! Announcing Dash 1.0](https://medium.com/plotly/welcoming-dash-1-0-0-f3af4b84bae)
-- [Community](https://community.plot.ly/c/api/python)
+- [Community forum](https://community.plot.ly/c/api/python)
---
@@ -75,13 +83,13 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
plotly.py may be installed using pip...
```
-pip install plotly==4.5.3
+pip install plotly==4.5.4
```
or conda.
```
-conda install -c plotly plotly=4.5.3
+conda install -c plotly plotly=4.5.4
```
### Jupyter Notebook Support
@@ -128,10 +136,10 @@ set NODE_OPTIONS=--max-old-space-size=4096
jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1 --no-build
# FigureWidget support
-jupyter labextension install plotlywidget@1.5.3 --no-build
+jupyter labextension install plotlywidget@1.5.4 --no-build
# and jupyterlab renderer support
-jupyter labextension install jupyterlab-plotly@1.5.3 --no-build
+jupyter labextension install jupyterlab-plotly@1.5.4 --no-build
# Build extensions (must be done to activate extensions since --no-build is used above)
jupyter lab build
@@ -153,7 +161,7 @@ installation of the plotly [orca](https://github.com/plotly/orca) command line u
These dependencies can both be installed using conda:
```
-conda install -c plotly plotly-orca psutil
+conda install -c plotly plotly-orca==1.3.1 psutil
```
Or, `psutil` can be installed using pip...
diff --git a/binder/requirements.txt b/binder/requirements.txt
index 99450c1574a..bd883d748bc 100644
--- a/binder/requirements.txt
+++ b/binder/requirements.txt
@@ -1,12 +1,12 @@
jupytext
-plotly==4.5.1
+plotly==4.5.4
jupyter
notebook
-pandas==0.23.0
+pandas
statsmodels==0.10.1
-scipy==1.3.1
+scipy
patsy==0.5.1
-numpy==1.16.0
+numpy
plotly-geo
psutil
requests
@@ -14,3 +14,4 @@ networkx
scikit-image
datashader
pyarrow
+cufflinks==0.17.3
diff --git a/contributing.md b/contributing.md
index 78d1727f583..98275b44f34 100644
--- a/contributing.md
+++ b/contributing.md
@@ -1,22 +1,104 @@
# Contributing
-Thank you for contributing to plotly.py!
+Thank you for contributing to plotly.py! We are actively looking for
+diverse contributors, with diverse background and skills.
+
+This guide start by a general description of the different ways to contribute
+to plotly.py, then we explain some technical aspects of preparing your
+contribution.
## Code of Conduct
-Check out the [Code of Conduct](CODE_OF_CONDUCT.md). Don't tl:dr; it, but the general idea is to be nice.
+Please check out the [Code of Conduct](CODE_OF_CONDUCT.md). Don't tl:dr; it,
+but the general idea is to be nice.
+
+## What are the different ways to contribute?
+
+There are many ways to contribute to plotly.py. It helps to understand first
+the structure of the code and of the repository.
+
+- the `codegen` (package in `packages/python/plotly/codegen`): all the code
+ inside `plotly.graph_objects` is generated from the plotly javascript API
+ (the "schema"). The `codegen` package is where the code generation is done.
+ Most of the codegen code concerns the generation of docstrings. Traces and
+ Layout classes have a direct correspondence with their Javascript
+ counterpart. Additional methods are defined for the `Figure` object, such as
+ `update_layout`, `add_trace`, etc.
+
+- the `plotly.express` package (usually imported as `px`) is a high-level
+ functional API. Its code is in `packages/python/plotly/express`. Most
+ functions of `plotly.express` call the internal `_make_figure` function
+ in `_core.py`. More generally, the internals of `px` consist of general
+ functions taking care of building the figure (defining subplots, traces
+ or frames, for example), with special cases for different traces handled
+ within these functions. There is also subsequent code reuse for `px`
+ docstrings, in particular for documenting parameters.
+
+- the `plotly.figure_factory` module provides Python "recipes" for building
+ advanced visualizations, such as Gantt charts, annotated heatmaps, etc.
+ Figure factories are one of the easiest entry points into plotly.py, since
+ they consist of Python-only code, with standalone, well-separated functions.
+ However, please note that some of the figure factories become less relevant
+ as we are introducing more features into `plotly.express`. Some issues in the
+ tracker are labeled "figure_factory" and can be good issues to work on. More
+ instructions on figure factories are found
+ [here](packages/python/plotly/plotly/figure_factory/README.md).
+
+- other pure-Python submodules are: `plotly.io` (low-level interface for
+ displaying, reading and writing figures), `plotly.subplots` (helper function
+ for layout of multi-plot figures)
+
+- tests are found in `packages/python/plotly/plotly/tests`. Different
+ directories correspond to different test jobs (with different dependency sets)
+ run in continuous integration. These jobs are configured in
+ `packages/python/plotly/tox.ini`, which itself is used in the Circle CI
+ configuration file `.circleci/config.yml`. More is explained about tests
+ in the following "Technical aspects" section.
+
+- the **documentation** is part of this repository. Its structure and some
+ explanations are described [here](doc/README.md). The documentation, in
+ particular example-based tutorials, is a great place to start contributing.
+ The contribution process is also more lightweight, since you can modify
+ tutorial notebooks without setting up an environment, etc.
+ We maintain a wishlist of examples to add on
+ https://github.com/plotly/plotly.py/issues/1965. If you have writing skills,
+ the wording of existing examples can also be improved in places.
+
+Contributing code or documentation are not the only way to contribute! You can
+also contribute to the project by
+
+- reporting bugs (see below).
+
+- submitting feature requests (maybe we'll convince you to contribute it as a
+ pull request!).
+
+- helping other users on the [community forum](https://community.plot.ly/).
+ Join the list of [nice people](https://community.plot.ly/u) helping other
+ plotly users :-).
+
+We also recommend reading the great
+[how to contribute to open source](https://opensource.guide/how-to-contribute/)
+guide.
## Have a Bug Report?
-Open an issue! Go to https://github.com/plotly/plotly.py/issues. It's possible that your issue was already addressed. If it wasn't, open it. We also accept PRs; take a look at the steps below for instructions on how to do this.
+Open an issue! Go to https://github.com/plotly/plotly.py/issues. It's possible that your issue was already addressed. If it wasn't, open it. We also accept pull requests; take a look at the steps below for instructions on how to do this.
## Have Questions about Plotly?
-Check out our Support App: https://support.plot.ly/libraries/python or Community Forum: https://community.plot.ly/.
+Check out our Community Forum: https://community.plot.ly/.
## Want to improve the plotly documentation?
-Thank you! Instructions on how to contribute to the documentation are given [here](doc/contributing.md). Please also read the next section if you need to setup a development environment.
+Thank you! Instructions on how to contribute to the documentation are given [here](doc/README.md). Please also read the next section if you need to setup a development environment.
+
+## How to contribute - Technical Aspects
+
+Below we explain the technical aspects of contributing. It is not strictly necessary to follow all points (for example, you will not write tests when writing documentation, most of the time), but we want to make sure that you know how to deal with most cases.
+
+Note that if you are modifying a single documentation page, you can do it
+directly on Github by clicking on the "Edit this page on GitHub" link, without
+cloning the repository.
## Setup a Development Environment
@@ -31,6 +113,9 @@ git clone https://github.com/your_github_username/plotly.py.git
cd plotly.py
```
+Note: if you're just getting started with git, there exist great resources to
+learn and become confident about git, like http://try.github.io/.
+
### Create a virtual environment for plotly development
You can use either [conda][conda-env] or [virtualenv][virtualenv] to create a virtual environment for plotly development, e.g.
@@ -54,6 +139,10 @@ conda activate plotly-dev
$ pip install -e packages/python/chart-studio/
$ pip install -e packages/python/plotly-geo/
+This will ensure that the installed packages links to your local development
+directory, meaning that all changes you make reflect directly in your
+environment (don't forget to restart the Jupyter kernel though!).
+
### ipywidgets development install
Run the following commands in your virtual environment to use the
@@ -68,6 +157,7 @@ To make plotly plots show up in JupyterLab, you also need to [install the plotly
[plotly-jl]: https://plot.ly/python/getting-started/#jupyterlab-support-python-35
### Configure black code formatting
+
This repo uses the [Black](https://black.readthedocs.io/en/stable/) code formatter,
and the [pre-commit](https://pre-commit.com/) library to manage a git commit hook to
run Black prior to each commit. Both pre-commit and black are included in the
@@ -106,7 +196,8 @@ git checkout -b my-dev-branch
### Pull Request When Ready
-Once you've made your changes (and hopefully written some tests...), make that pull request!
+Once you've made your changes (and hopefully written some tests, see below for more about testing...),
+make that pull request!
## Update to a new version of Plotly.js
@@ -212,363 +303,3 @@ You're *strongly* encouraged to write tests that check your added functionality.
When you write a new test anywhere under the `tests` directory, if your PR gets accepted, that test will run in a virtual machine to ensure that future changes don't break your contributions!
Test accounts include: `PythonTest`, `PlotlyImageTest`, and `PlotlyStageTest`.
-
-## Release process - plotly package
-
-This is the release process for releasing `plotly.py` version `X.Y.Z` with
-`plotlywidget`/`jupyterlab-plotly` version `A.B.C`.
-
-Note: The `plotlywidget` instructions must be followed if any change
-has been made in the `packages/javascript` directory source code, OR if the version of
-plotly.js has been updated. If neither of these is the case, there's no need
-to increment the `plotlywidget` version or to publish a new version to npm.
-
-### Create a release branch
-After all of the functionality for the release has been merged into master,
-create a branch named `release_X.Y.Z`. This branch will become the
-final version
-
-### Finalize changelog
-Review the contents of `packages/python/plotly/CHANGELOG.md`. We try to follow
-the [keepachangelog](https://keepachangelog.com/en/1.0.0/) guidelines.
-Make sure the changelog includes the version being published at the top, along
-with the expected publication date.
-
-Use the `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security`
-labels for all changes to plotly.py. If the version of plotly.js has
-been updated, include this as the first `Updated` entry. Call out any
-noteable changes as sub-bullets (new trace types in particular), and provide
-a link to the plotly.js CHANGELOG.
-
-As the first entry in the changelog, include a `JupyterLab Versions` section.
-Here, document the versions of `plotlywidget`,
-`@jupyter-widgets/jupyterlab-manager`, `jupyterlab`, and
-`@jupyterlab/plotly-extension` that are known to be compatible with this
-version of `plotly.py`.
-
-Note: Use the official (not release candidate) versions in the CHANGELOG.
-
-### Update README.md installation instructions
-
-Update the installation instructions in the README to the new versions of all
-of the dependencies. Use the release candidate versions, this way we can point
-people to the README of the `release_X.Y.Z` as the instructions for trying out
-the release candidate.
-
-Note that the conda installation instructions must include
-"-c plotly/lable/test" rather than "-c plotly" in order to install the
-release candidate version.
-
-Update the `doc/python/getting-started.md` file with the same version numbers.
-
-Commit Changelog, README and getting-started updates.
-
-### Bump to release candidate version
- 1) Manually update the plotlywidget version to `A.B.C-rc.1` in the files
-specified below.
-
- - `packages/python/plotly/plotly/_widget_version.py`:
- + Update `__frontend_version__` to `^A.B.C-rc.1` (Note the `^` prefix)
- - `packages/javascript/plotlywidget/package.json`
- + Update `"version"` to `A.B.C-rc.1`
- + Run `npm install && npm run build`
- - `packages/javascript/jupyterlab-plotly/package.json`
- + Update `"version"` to `A.B.C-rc.1`
- + Run `npm install && npm run build`
-
- 2) Commit the changes
-
- 3) Tag this commit on the release branch as `vX.Y.Zrc1` and `widget-vA.B.C-rc.1`
-
-In both cases `rc` is the semantic versioning code for Release Candidate.
-
-The number 1 means that this is the first release candidate, this number can
-be incremented if we need to publish multiple release candidates.
-Note that the `npm` suffix is `-rc.1` and the PyPI suffix is `rc1`.
-
-Publishing `plotly.py` and `plotlywidget` as release candidates
-allows us to go through the publication process, and test that the
-installed packages work properly before general users will get them by
-default. It also gives us the opportunity to ask specific users to test
-that their bug reports are in fact resolved before we pull the trigger
-on the official release.
-
-### Publish release candidate to PyPI
-To upload to PyPI you'll also need to have `twine` installed:
-```bash
-(plotly_dev) $ pip install twine
-```
-
-And, you'll need the credentials file `~/.pypirc`. Request access from
-@jonmmease and @chriddyp. Then, from inside the repository:
-
-```bash
-(plotly_dev) $ cd packages/python/plotly
-(plotly_dev) $ git checkout release_X.Y.Z
-(plotly_dev) $ git stash
-(plotly_dev) $ rm -rf dist
-(plotly_dev) $ python setup.py sdist bdist_wheel
-(plotly_dev) $ rm dist/*dirty*
-(plotly_dev) $ twine upload dist/plotly-X.Y.Zrc1*
-```
-
-Note: this will intentionally fail if your current git tree is dirty, because we want the tag
-to reflect what is being released, and the version number comes from the tag and the dirty-state.
-
-
-### Publish release candidate of `plotlywidget` and `jupyterlab-plotly` to NPM
-Now, publish the release candidate of the `plotlywidget` NPM package.
-
-```bash
-cd ./packages/javascript/plotlywidget
-npm run build && npm publish --access public --tag next
-```
-
-The `--tag next` part ensures that users won't install this version unless
-they explicitly ask for the version or for the version wtih the `next` tag.
-
-Do the same in the `jupyterlab-plotly` directory.
-
-### Publish release candidate to plotly anaconda channel
-To publish package to the plotly anaconda channel you'll need to have the
-anaconda or miniconda distribution installed, and you'll need to have the
-`anaconda-client` package installed.
-
-```bash
-(plotly_dev) $ conda config --set anaconda_upload no
-(plotly_dev) $ conda build recipe/
-```
-
-Next run `anaconda login` and enter the credentials for the plotly anaconda
-channel.
-
-Then upload artifacts to the anaconda channel using the test label. Using the test
-label will ensure that people will only download the release candidate version
-if they explicitly request it.
-
-```
-$ anaconda upload --label test /path/to/anaconda3/conda-bld/noarch/plotly-*.tar.bz2
-```
-
-Then logout with `anaconda logout`
-
-### Manually test the release candidate
-Create a fresh virtual environment (or conda environment) and install
-the release candidate by following the new `README.md` instructions
-(the instructions updated above to include the release candidate versions)
-
-Run through the example notebooks at
-https://github.com/jonmmease/plotly_ipywidget_notebooks using the classic
-notebook and JupyterLab. Make sure `FigureWidget` objects are displayed as
-plotly figures, and make sure the in-place updates and callbacks work.
-
-If appropriate, ask users who have submitted bug reports or feature
-requests that are resolved in this version to try out the release candidate.
-
-If problems are found in the release candidate, fix them on the release
-branch and then publish another release candidate with the candidate number
-incremented.
-
-### Finalize CHANGELOG and README
-Update CHANGELOG with release date and update README with final versions.
-
-In the conda installation instructions, be sure to change the
-"-c plotly/label/test" argument to "-c plotly"
-
-Commit updates.
-
-### Finalize versions
-When no problems are identified in the release candidate, remove the
-release candidate suffix from the following version strings:
-
- - `plotly/_widget_version.py`:
- + Update `__frontend_version__` to `^A.B.C` (Note the `^` prefix)
- - `packages/javascript/plotlywidget/package.json`
- + Update `"version"` to `A.B.C`
- + Run `npm install && npm run build`
- - `packages/javascript/jupyterlab-plotly/package.json`
- + Update `"version"` to `A.B.C`
- + Run `npm install && npm run build`
-
-Commit and push to the release branch.
-
-### Merge release into master
-Make sure the integration tests are passing on the release branch, then merge
-it into master on GitHub.
-
-Make sure tests also pass on master, then update your local master,
-tag this merge commit as `vX.Y.Z` (e.g. `v3.1.1`) and `widget-vA.B.C`
-
-push the tag.
-
-```bash
-(plotly_dev) $ git checkout master
-(plotly_dev) $ git stash
-(plotly_dev) $ git pull origin master
-(plotly_dev) $ git tag vX.Y.Z
-(plotly_dev) $ git push origin vX.Y.Z
-(plotly_dev) $ git tag widget-vA.B.C
-(plotly_dev) $ git push origin widget-vA.B.C
-```
-
-### Publishing to PYPI
-
-Publish the final version to PyPI
-
-```bash
-(plotly_dev) $ cd packages/python/plotly
-(plotly_dev) $ rm -rf dist
-(plotly_dev) $ python setup.py sdist bdist_wheel
-(plotly_dev) $ rm dist/*dirty*
-(plotly_dev) $ twine upload dist/plotly-X.Y.Z*
-```
-
-Note: this will intentionally fail if your current git tree is dirty, because we want the tag
-to reflect what is being released, and the version number comes from the tag and the dirty-state.
-
-After it has uploaded, move to another environment and double+triple check that you are able to upgrade ok:
-```bash
-$ pip install plotly --upgrade
-```
-
-And ask one of your friends to do it too. Our tests should catch any issues, but you never know.
-
-<3 Team Plotly
-
-### Publish widget library to npm
-Finally, publish the final version of the widget library to npm with:
-
-```bash
-cd packages/javascript/jupyterlab-plotly
-npm run build && npm publish --access public
-cd packages/javascript/plotlywidget
-npm run build && npm publish --access public
-```
-
-### Publishing to the plotly conda channel
-Follow the anaconda upload instructions as described for the release candidate
-above, except:
-
- - Do not include the `--label test` argument when uploading
-
-```
-$ anaconda upload /path/to/anaconda3/conda-bld/noarch/plotly-*.tar.bz2
-```
-
-### Add GitHub Release entry
-Go to https://github.com/plotly/plotly.py/releases and "Draft a new release"
-
-Enter the vX.Y.Z tag
-
-Make "Release title" the same string as the tag.
-
-Copy changelog section for this version as the "Describe this release"
-
-### Upgrade doc requirements and API doc
-
-Files to be updated:
-- `doc/apidoc/conf.py` with new version number
-- `doc/requirements.txt`
-- `binder/requirements.txt`
-
-### Synchronize master and doc-prod branches
-
-doc-prod should already have been merged on a regular basis into master, but
-start doing it first. Then merge master into doc-prod to deploy the doc related
-to features in the release.
-
-### Post announcement
-Post a simple announcement to the Plotly Python forum, with links to the
-README installation instructions and to the CHANGELOG.
-
-## Release process - plotly-geo package
-The `plotly-geo` package contains the shape file resources used by plotly.py.
-These files are relatively large and change infrequently so it is useful
-to release them in a separate package.
-
-### Update version
-Update the version of the `plotly-geo` package in
-`packages/python/plotly-geo/setup.py`.
-
-This version is not intended to match the version of plotly.py.
-
-### Update CHANGELOG
-Add a new entry to the CHANGELOG at `packages/python/plotly-geo/CHANGELOG.md`
-and commit the changes.
-
-### Tag Release
-Create a new tag for the release
-
-```bash
-(plotly_dev) $ git checkout master
-(plotly_dev) $ git stash
-(plotly_dev) $ git pull origin master
-(plotly_dev) $ git tag plotly-geo-vX.Y.Z
-(plotly_dev) $ git push origin plotly-geo-vX.Y.Z
-```
-
-### Publishing to PYPI
-Publish the final version to PyPI
-
-```bash
-(plotly_dev) $ cd packages/python/plotly-geo
-(plotly_dev) $ python setup.py sdist bdist_wheel
-(plotly_dev) $ twine upload dist/plotly-geo-X.Y.Z.tar.gz
-(plotly_dev) $ twine upload dist/plotly_geo-X.Y.Z-py3-none-any.whl
-```
-
-### Publish to plotly anaconda channel
-From `packages/python/plotly-geo`, build the conda packge
-```bash
-(plotly_dev) $ conda build recipe/
-```
-
-Then upload to the plotly anaconda channel as described above
-
-## Release process - chart-studio package
-The `chart-studio` package contains the utilities for interacting with
-Chart Studio (both Cloud or On-Prem).
-
-### Update version
-Update the version of the `chart-studio` package in
-`packages/python/chart-studio/setup.py`.
-
-This version is not intended to match the version of plotly.py.
-
-### Update CHANGELOG
-Add a new entry to the CHANGELOG at `packages/python/chart-studio/CHANGELOG.md`
-and commit the changes.
-
-### Tag Release
-Create a new tag for the release
-
-```bash
-(plotly_dev) $ git checkout master
-(plotly_dev) $ git stash
-(plotly_dev) $ git pull origin master
-(plotly_dev) $ git tag chart-studio-vX.Y.Z
-(plotly_dev) $ git push origin chart-studio-vX.Y.Z
-```
-
-### Publishing to PYPI
-Publish the final version to PyPI
-
-```bash
-(plotly_dev) $ cd packages/python/chart-studio
-(plotly_dev) $ python setup.py sdist bdist_wheel
-(plotly_dev) $ twine upload dist/chart-studio-X.Y.Z.tar.gz
-(plotly_dev) $ twine upload dist/chart_studio-X.Y.Z-py3-none-any.whl
-```
-
-### Publish to plotly anaconda channel
-From `packages/python/plotly-geo`, build the conda packge
-```bash
-(plotly_dev) $ conda build recipe/
-```
-
-Then upload to the plotly anaconda channel as described above
-
-## Contributing to the Figure Factories
-If you are interested in contributing to the ever-growing Plotly figure factory library in Python, check out the [documentation][ff-home] to learn how.
-
-[ff-home]: packages/python/plotly/plotly/figure_factory/README.md
diff --git a/doc/Makefile b/doc/Makefile
index fa8e525dd6b..5e9861159a1 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -30,6 +30,7 @@ $(IPYNB_FILES): $(IPYNB_DIR)/.mapbox_token
$(IPYNB_DIR)/%.ipynb: $(MD_DIR)/%.md
@mkdir -p $(IPYNB_DIR)
@echo "[jupytext] $<"
+ @cat what_about_dash.md >> $<
@jupytext $< --to notebook --quiet --output $@
$(HTML_DIR)/2019-07-03-%.html: $(IPYNB_DIR)/%.ipynb
diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile
index 8b64b1e99ec..7a8c2aa1a35 100644
--- a/doc/apidoc/Makefile
+++ b/doc/apidoc/Makefile
@@ -15,5 +15,14 @@ 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
+ sed -i 's/graph_objs/graph_objects/g' _build/html/*.inv
+ sed -i 's/graph_objs/graph_objects/g' _build/html/*.js
+ sed -i 's/graph_objs/graph_objects/g' _build/html/generated/*.html
+ sed -i 's/graph_objs/graph_objects/g' _build/html/generated/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/conf.py b/doc/apidoc/conf.py
index a4d5c663dce..ff8ca480586 100644
--- a/doc/apidoc/conf.py
+++ b/doc/apidoc/conf.py
@@ -28,7 +28,7 @@
# The short X.Y version
version = ""
# The full version, including alpha/beta/rc tags
-release = "4.5.1"
+release = "4.5.4"
# -- General configuration ---------------------------------------------------
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/doc/python/2D-Histogram.md b/doc/python/2D-Histogram.md
index ecaf3ae26d3..864ddd85c65 100644
--- a/doc/python/2D-Histogram.md
+++ b/doc/python/2D-Histogram.md
@@ -71,7 +71,7 @@ fig = go.Figure(go.Histogram2d(x=x, y=y, histnorm='probability',
fig.show()
```
### Sharing bin settings between 2D Histograms
-This example shows how to use [bingroup](https://plot.ly/python/reference/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plot.ly/python/reference/#histogram2dcontour-ybins) and `xbins`.
+This example shows how to use [bingroup](https://plotly.com/python/reference/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plotly.com/python/reference/#histogram2dcontour-ybins) and `xbins`.
```python
import plotly.graph_objects as go
@@ -170,4 +170,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#histogram2d for more information and chart attribute options!
+See https://plotly.com/python/reference/#histogram2d for more information and chart attribute options!
diff --git a/doc/python/2d-histogram-contour.md b/doc/python/2d-histogram-contour.md
index 395e134c958..e159ab33597 100644
--- a/doc/python/2d-histogram-contour.md
+++ b/doc/python/2d-histogram-contour.md
@@ -185,4 +185,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#histogram2dcontour for more information and chart attribute options!
+See https://plotly.com/python/reference/#histogram2dcontour for more information and chart attribute options!
diff --git a/doc/python/3d-axes.md b/doc/python/3d-axes.md
index ed10b669f83..ee8aa79f7b9 100644
--- a/doc/python/3d-axes.md
+++ b/doc/python/3d-axes.md
@@ -39,7 +39,7 @@ jupyter:
attributes such as `xaxis`, `yaxis` and `zaxis` parameters, in order to
set the range, title, ticks, color etc. of the axes.
-For creating 3D charts, see [this page](https://plot.ly/python/3d-charts/).
+For creating 3D charts, see [this page](https://plotly.com/python/3d-charts/).
```python
import plotly.graph_objects as go
@@ -141,7 +141,7 @@ fig.show()
import plotly.graph_objects as go
import numpy as np
-# Define random surface
+# Define random surface
N = 50
fig = go.Figure(data=[go.Mesh3d(x=(60*np.random.randn(N)),
y=(25*np.random.randn(N)),
@@ -150,7 +150,7 @@ fig = go.Figure(data=[go.Mesh3d(x=(60*np.random.randn(N)),
color='rgba(100,22,200,0.5)'
)])
-# Different types of customized ticks
+# Different types of customized ticks
fig.update_layout(scene = dict(
xaxis = dict(
ticktext= ['TICKS','MESH','PLOTLY','PYTHON'],
@@ -184,7 +184,7 @@ fig = go.Figure(data=[go.Mesh3d(x=(30*np.random.randn(N)),
opacity=0.5,)])
-# xaxis.backgroundcolor is used to set background color
+# xaxis.backgroundcolor is used to set background color
fig.update_layout(scene = dict(
xaxis = dict(
backgroundcolor="rgb(200, 200, 230)",
diff --git a/doc/python/3d-bubble-charts.md b/doc/python/3d-bubble-charts.md
index 861551a9e1a..f0848562980 100644
--- a/doc/python/3d-bubble-charts.md
+++ b/doc/python/3d-bubble-charts.md
@@ -108,7 +108,7 @@ fig = go.Figure(data=go.Scatter3d(
mode = 'markers',
marker = dict(
sizemode = 'diameter',
- sizeref = 750, # info on sizeref: https://plot.ly/python/reference/#scatter-marker-sizeref
+ sizeref = 750, # info on sizeref: https://plotly.com/python/reference/#scatter-marker-sizeref
size = planet_diameter,
color = planet_colors,
)
@@ -147,7 +147,7 @@ fig = go.Figure(go.Scatter3d(
mode = 'markers',
marker = dict(
sizemode = 'diameter',
- sizeref = 750, # info on sizeref: https://plot.ly/python/reference/#scatter-marker-sizeref
+ sizeref = 750, # info on sizeref: https://plotly.com/python/reference/#scatter-marker-sizeref
size = planet_diameter,
color = temperatures,
colorbar_title = 'Mean
Temperature',
@@ -167,4 +167,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatter3d and https://plot.ly/python/reference/#scatter-marker-sizeref
for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter3d and https://plotly.com/python/reference/#scatter-marker-sizeref
for more information and chart attribute options!
diff --git a/doc/python/3d-camera-controls.md b/doc/python/3d-camera-controls.md
index e847361a6d4..2bba80fa814 100644
--- a/doc/python/3d-camera-controls.md
+++ b/doc/python/3d-camera-controls.md
@@ -290,4 +290,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#layout-scene-camera for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-scene-camera for more information and chart attribute options!
diff --git a/doc/python/3d-isosurface-plots.md b/doc/python/3d-isosurface-plots.md
index 87cdc446951..2b444353f2e 100644
--- a/doc/python/3d-isosurface-plots.md
+++ b/doc/python/3d-isosurface-plots.md
@@ -235,5 +235,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#isosurface for more information and chart attribute options!
+See https://plotly.com/python/reference/#isosurface for more information and chart attribute options!
diff --git a/doc/python/3d-line-plots.md b/doc/python/3d-line-plots.md
index 0861b9760a4..f49992f785a 100644
--- a/doc/python/3d-line-plots.md
+++ b/doc/python/3d-line-plots.md
@@ -120,4 +120,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatter3d-marker-line for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter3d-marker-line for more information and chart attribute options!
diff --git a/doc/python/3d-mesh.md b/doc/python/3d-mesh.md
index 24ce40317d4..d180df26fe6 100644
--- a/doc/python/3d-mesh.md
+++ b/doc/python/3d-mesh.md
@@ -163,4 +163,4 @@ fig.show()
```
## Reference
-See https://plot.ly/python/reference/#mesh3d for more information and chart attribute options!
+See https://plotly.com/python/reference/#mesh3d for more information and chart attribute options!
diff --git a/doc/python/3d-scatter-plots.md b/doc/python/3d-scatter-plots.md
index e102cac7fe4..eedc437f719 100644
--- a/doc/python/3d-scatter-plots.md
+++ b/doc/python/3d-scatter-plots.md
@@ -37,7 +37,7 @@ jupyter:
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
-Like the [2D scatter plot](https://plot.ly/python/line-and-scatter/) `px.scatter`, the 3D function `px.scatter_3d` plots individual data in three-dimensional space.
+Like the [2D scatter plot](https://plotly.com/python/line-and-scatter/) `px.scatter`, the 3D function `px.scatter_3d` plots individual data in three-dimensional space.
```python
import plotly.express as px
@@ -77,7 +77,7 @@ fig.update_layout(margin=dict(l=0, r=0, b=0, t=0))
#### Basic 3D Scatter Plot
If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Scatter3D` from `plotly.graph_objs`.
-Like the [2D scatter plot](https://plot.ly/python/line-and-scatter/) `go.Scatter`, `go.Scatter3d` plots individual data in three-dimensional space.
+Like the [2D scatter plot](https://plotly.com/python/line-and-scatter/) `go.Scatter`, `go.Scatter3d` plots individual data in three-dimensional space.
```python
import plotly.graph_objects as go
@@ -122,7 +122,7 @@ fig.show()
### Dash App
-[Dash](https://plot.ly/products/dash/) is an Open Source Python library which can help you convert plotly figures into a reactive, web-based application. Below is a simple example of a dashboard created using Dash. Its [source code](https://github.com/plotly/simple-example-chart-apps/tree/master/dash-3dscatterplot) can easily be deployed to a PaaS.
+[Dash](https://plotly.com/products/dash/) is an Open Source Python library which can help you convert plotly figures into a reactive, web-based application. Below is a simple example of a dashboard created using Dash. Its [source code](https://github.com/plotly/simple-example-chart-apps/tree/master/dash-3dscatterplot) can easily be deployed to a PaaS.
```python
from IPython.display import IFrame
@@ -136,4 +136,4 @@ IFrame(src= "https://dash-simple-apps.plotly.host/dash-3dscatterplot/code", widt
#### Reference
-See https://plot.ly/python/reference/#scatter3d for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter3d for more information and chart attribute options!
diff --git a/doc/python/3d-subplots.md b/doc/python/3d-subplots.md
index ba48768c252..a5b09729316 100644
--- a/doc/python/3d-subplots.md
+++ b/doc/python/3d-subplots.md
@@ -82,4 +82,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/subplots/ for more information regarding subplots!
+See https://plotly.com/python/subplots/ for more information regarding subplots!
diff --git a/doc/python/3d-surface-coloring.md b/doc/python/3d-surface-coloring.md
index 36ad5b8739b..c8c2355c46f 100644
--- a/doc/python/3d-surface-coloring.md
+++ b/doc/python/3d-surface-coloring.md
@@ -60,5 +60,5 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#surface-surfacecolor for more information!
+See https://plotly.com/python/reference/#surface-surfacecolor for more information!
diff --git a/doc/python/3d-surface-plots.md b/doc/python/3d-surface-plots.md
index 3f7be394df3..7c407f2ca99 100644
--- a/doc/python/3d-surface-plots.md
+++ b/doc/python/3d-surface-plots.md
@@ -76,7 +76,7 @@ fig.show()
#### Surface Plot With Contours
-Display and customize contour data for each axis using the `contours` attribute ([reference](plot.ly/python/reference/#surface-contours)).
+Display and customize contour data for each axis using the `contours` attribute ([reference](plotly.com/python/reference/#surface-contours)).
```python
import plotly.graph_objects as go
@@ -98,7 +98,7 @@ fig.update_layout(title='Mt Bruno Elevation', autosize=False,
fig.show()
```
#### Configure Surface Contour Levels
-This example shows how to slice the surface graph on the desired position for each of x, y and z axis. [contours.x.start](https://plot.ly/python/reference/#surface-contours-x-start) sets the starting contour level value, `end` sets the end of it, and `size` sets the step between each contour level.
+This example shows how to slice the surface graph on the desired position for each of x, y and z axis. [contours.x.start](https://plotly.com/python/reference/#surface-contours-x-start) sets the starting contour level value, `end` sets the end of it, and `size` sets the step between each contour level.
```python
import plotly.graph_objects as go
@@ -166,4 +166,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#surface for more information!
+See https://plotly.com/python/reference/#surface for more information!
diff --git a/doc/python/3d-volume.md b/doc/python/3d-volume.md
index 21094aab6ed..1609deeb113 100644
--- a/doc/python/3d-volume.md
+++ b/doc/python/3d-volume.md
@@ -190,7 +190,7 @@ fig = go.Figure(data=go.Volume(
))
# Change camera view for a better view of the sides, XZ plane
-# (see https://plot.ly/python/v3/3d-camera-controls/)
+# (see https://plotly.com/python/v3/3d-camera-controls/)
fig.update_layout(scene_camera = dict(
up=dict(x=0, y=0, z=1),
center=dict(x=0, y=0, z=0),
@@ -254,7 +254,7 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#volume for more information and chart attribute options!
+See https://plotly.com/python/reference/#volume for more information and chart attribute options!
#### See also
[3D isosurface documentation](/python/3d-isosurface-plots/)
diff --git a/doc/python/aggregations.md b/doc/python/aggregations.md
index 7a3ec5d69ae..ccd0aeb36a8 100644
--- a/doc/python/aggregations.md
+++ b/doc/python/aggregations.md
@@ -142,7 +142,7 @@ import plotly.io as pio
import pandas as pd
-df = pd.read_csv("https://plot.ly/~public.health/17.csv")
+df = pd.read_csv("https://plotly.com/~public.health/17.csv")
data = [dict(
x = df['date'],
@@ -270,4 +270,4 @@ pio.show(fig_dict, validate=False)
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/animations.md b/doc/python/animations.md
index bf8e21dd230..ed97e36e376 100644
--- a/doc/python/animations.md
+++ b/doc/python/animations.md
@@ -63,7 +63,7 @@ Along with `data` and `layout`, `frames` can be added as a key in a figure objec
#### Adding Control Buttons to Animations
-You can add play and pause buttons to control your animated charts by adding an `updatemenus` array to the `layout` of your `figure`. More information on style and placement of the buttons is available in Plotly's [`updatemenus` reference](https://plot.ly/python/reference/#layout-updatemenus).
+You can add play and pause buttons to control your animated charts by adding an `updatemenus` array to the `layout` of your `figure`. More information on style and placement of the buttons is available in Plotly's [`updatemenus` reference](https://plotly.com/python/reference/#layout-updatemenus).
The buttons are defined as follows:
@@ -389,5 +389,5 @@ fig.show()
#### Reference
-For additional information and attributes for creating bubble charts in Plotly see: https://plot.ly/python/bubble-charts/.
-For more documentation on creating animations with Plotly, see https://plot.ly/python/#animations.
+For additional information and attributes for creating bubble charts in Plotly see: https://plotly.com/python/bubble-charts/.
+For more documentation on creating animations with Plotly, see https://plotly.com/python/#animations.
diff --git a/doc/python/annotated-heatmap.md b/doc/python/annotated-heatmap.md
index 9a4a1312a98..4cb13541f7e 100644
--- a/doc/python/annotated-heatmap.md
+++ b/doc/python/annotated-heatmap.md
@@ -202,7 +202,7 @@ fig.show()
```
#### Reference
-For more info on Plotly heatmaps, see: https://plot.ly/python/reference/#heatmap.
For more info on using colorscales with Plotly see: https://plot.ly/python/heatmap-and-contour-colorscales/
For more info on annotated_heatmaps, see:
+For more info on Plotly heatmaps, see: https://plotly.com/python/reference/#heatmap.
For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/
For more info on annotated_heatmaps, see:
```python
help(ff.create_annotated_heatmap)
diff --git a/doc/python/axes.md b/doc/python/axes.md
index cdab606651e..9633b0a9530 100644
--- a/doc/python/axes.md
+++ b/doc/python/axes.md
@@ -477,7 +477,7 @@ fig.show()
### Set axis title position
-This example sets `standoff` attribute to cartesian axes to determine the distance between the tick labels and the axis title. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By default [automargin](https://plot.ly/python/setting-graph-size/#automatically-adjust-margins) is `True` in Plotly template for the cartesian axis, so the margins will be pushed to fit the axis title at given standoff distance.
+This example sets `standoff` attribute to cartesian axes to determine the distance between the tick labels and the axis title. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By default [automargin](https://plotly.com/python/setting-graph-size/#automatically-adjust-margins) is `True` in Plotly template for the cartesian axis, so the margins will be pushed to fit the axis title at given standoff distance.
```python
import plotly.graph_objects as go
@@ -743,7 +743,7 @@ fig.show()
#### Synchronizing axes in subplots with `matches`
-Using `facet_col` from `plotly.express` let [zoom](https://help.plot.ly/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plot.ly/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
+Using `facet_col` from `plotly.express` let [zoom](https://help.plotly.com/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plotly.com/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
Zoom in one trace below, to see the other subplots zoomed to the same x-axis range. To pan all the subplots, click and drag from the center of x-axis to the side:
@@ -764,4 +764,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#layout-xaxis and https://plot.ly/python/reference/#layout-yaxis for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-xaxis and https://plotly.com/python/reference/#layout-yaxis for more information and chart attribute options!
diff --git a/doc/python/bar-charts.md b/doc/python/bar-charts.md
index d4302dac5d0..c137c0b213c 100644
--- a/doc/python/bar-charts.md
+++ b/doc/python/bar-charts.md
@@ -50,7 +50,7 @@ fig.show()
data_canada
```
-### Customize bar chart with Plotly Express
+### Customize bar chart with Plotly Express
The bar plot can be customized using keyword arguments.
@@ -121,7 +121,7 @@ fig = go.Figure(data=[
go.Bar(name='SF Zoo', x=animals, y=[20, 14, 23]),
go.Bar(name='LA Zoo', x=animals, y=[12, 18, 29])
])
-# Change the bar mode
+# Change the bar mode
fig.update_layout(barmode='group')
fig.show()
```
@@ -213,7 +213,7 @@ fig.add_trace(go.Bar(
marker_color='lightsalmon'
))
-# Here we modify the tickangle of the xaxis, resulting in rotated labels.
+# Here we modify the tickangle of the xaxis, resulting in rotated labels.
fig.update_layout(barmode='group', xaxis_tickangle=-45)
fig.show()
```
@@ -336,7 +336,7 @@ fig.show()
### Bar Chart with Sorted or Ordered Categories
-Set `categoryorder` to `"category ascending"` or `"category descending"` for the alphanumerical order of the category names or `"total ascending"` or `"total descending"` for numerical order of values. [categoryorder](https://plot.ly/python/reference/#layout-xaxis-categoryorder) for more information. Note that sorting the bars by a particular trace isn't possible right now - it's only possible to sort by the total values. Of course, you can always sort your data _before_ plotting it if you need more customization.
+Set `categoryorder` to `"category ascending"` or `"category descending"` for the alphanumerical order of the category names or `"total ascending"` or `"total descending"` for numerical order of values. [categoryorder](https://plotly.com/python/reference/#layout-xaxis-categoryorder) for more information. Note that sorting the bars by a particular trace isn't possible right now - it's only possible to sort by the total values. Of course, you can always sort your data _before_ plotting it if you need more customization.
This example orders the bar chart alphabetically with `categoryorder: 'category ascending'`
@@ -382,8 +382,8 @@ fig.show()
### Horizontal Bar Charts
-See examples of horizontal bar charts [here](https://plot.ly/python/horizontal-bar-charts/).
+See examples of horizontal bar charts [here](https://plotly.com/python/horizontal-bar-charts/).
### Reference
-See https://plot.ly/python/reference/#bar for more information and chart attribute options!
+See https://plotly.com/python/reference/#bar for more information and chart attribute options!
diff --git a/doc/python/box-plots.md b/doc/python/box-plots.md
index 9a4fddd4dac..55952b6727c 100644
--- a/doc/python/box-plots.md
+++ b/doc/python/box-plots.md
@@ -36,7 +36,7 @@ jupyter:
thumbnail: thumbnail/box.jpg
---
-A [box plot](https://en.wikipedia.org/wiki/Box_plot) is a statistical representation of numerical data through their quartiles. The ends of the box represent the lower and upper quartiles, while the median (second quartile) is marked by a line inside the box. For other statistical representations of numerical data, see [other statistical charts](https://plot.ly/python/statistical-charts/).
+A [box plot](https://en.wikipedia.org/wiki/Box_plot) is a statistical representation of numerical data through their quartiles. The ends of the box represent the lower and upper quartiles, while the median (second quartile) is marked by a line inside the box. For other statistical representations of numerical data, see [other statistical charts](https://plotly.com/python/statistical-charts/).
## Box Plot with `plotly.express`
@@ -134,7 +134,7 @@ fig.show()
## Box plot with go.Box
-If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Box` function from `plotly.graph_objects`. All available options for `go.Box` are described in the reference page https://plot.ly/python/reference/#box.
+If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Box` function from `plotly.graph_objects`. All available options for `go.Box` are described in the reference page https://plotly.com/python/reference/#box.
### Basic Box Plot
@@ -280,7 +280,7 @@ fig.add_trace(go.Box(
name="All Points",
jitter=0.3,
pointpos=-1.8,
- boxpoints='all', # represent all points
+ boxpoints='all', # represent all points
marker_color='rgb(7,40,89)',
line_color='rgb(7,40,89)'
))
@@ -353,7 +353,7 @@ fig.add_trace(go.Box(
fig.update_layout(
yaxis_title='normalized moisture',
- boxmode='group' # group together boxes of the different traces for each value of x
+ boxmode='group' # group together boxes of the different traces for each value of x
)
fig.show()
```
@@ -491,4 +491,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#box for more information and chart attribute options!
+See https://plotly.com/python/reference/#box for more information and chart attribute options!
diff --git a/doc/python/bubble-charts.md b/doc/python/bubble-charts.md
index 4018c782b7d..348825851da 100644
--- a/doc/python/bubble-charts.md
+++ b/doc/python/bubble-charts.md
@@ -36,7 +36,7 @@ jupyter:
## Bubble chart with plotly.express
-A [bubble chart](https://en.wikipedia.org/wiki/Bubble_chart) is a scatter plot in which a third dimension of the data is shown through the size of markers. For other types of scatter plot, see the [line and scatter page](https://plot.ly/python/line-and-scatter/).
+A [bubble chart](https://en.wikipedia.org/wiki/Bubble_chart) is a scatter plot in which a third dimension of the data is shown through the size of markers. For other types of scatter plot, see the [line and scatter page](https://plotly.com/python/line-and-scatter/).
We first show a bubble chart example using Plotly Express. [Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/). The size of markers is set from the dataframe column given as the `size` parameter.
@@ -52,7 +52,7 @@ fig.show()
## Bubble Chart with plotly.graph_objects
-If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Scatter` from `plotly.graph_objects`, and define the size of markers to create a bubble chart. All of the available options are described in the scatter section of the reference page: https://plot.ly/python/reference#scatter.
+If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Scatter` from `plotly.graph_objects`, and define the size of markers to create a bubble chart. All of the available options are described in the scatter section of the reference page: https://plotly.com/python/reference#scatter.
### Simple Bubble Chart
@@ -91,8 +91,8 @@ fig.show()
To scale the bubble size, use the attribute `sizeref`. We recommend using the following formula to calculate a `sizeref` value:
`sizeref = 2. * max(array of size values) / (desired maximum marker size ** 2)`
-Note that setting 'sizeref' to a value greater than 1, decreases the rendered marker sizes, while setting 'sizeref' to less than 1, increases the rendered marker sizes. See https://plot.ly/python/reference/#scatter-marker-sizeref for more information.
-Additionally, we recommend setting the sizemode attribute: https://plot.ly/python/reference/#scatter-marker-sizemode to area.
+Note that setting 'sizeref' to a value greater than 1, decreases the rendered marker sizes, while setting 'sizeref' to less than 1, increases the rendered marker sizes. See https://plotly.com/python/reference/#scatter-marker-sizeref for more information.
+Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/#scatter-marker-sizemode to area.
```python
import plotly.graph_objects as go
@@ -222,4 +222,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#scatter for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter for more information and chart attribute options!
diff --git a/doc/python/bubble-maps.md b/doc/python/bubble-maps.md
index 864312a6a1e..d9c1b78a20f 100644
--- a/doc/python/bubble-maps.md
+++ b/doc/python/bubble-maps.md
@@ -50,7 +50,7 @@ fig = px.scatter_geo(df, locations="iso_alpha", color="continent",
fig.show()
```
-### Bubble Map with animation
+### Bubble Map with animation
```python
import plotly.express as px
@@ -74,7 +74,7 @@ To scale the bubble size, use the attribute sizeref. We recommend using the foll
Note that setting `sizeref` to a value greater than $1$, decreases the rendered marker sizes, while setting `sizeref` to less than $1$, increases the rendered marker sizes.
-See https://plot.ly/python/reference/#scatter-marker-sizeref for more information. Additionally, we recommend setting the sizemode attribute: https://plot.ly/python/reference/#scatter-marker-sizemode to area.
+See https://plotly.com/python/reference/#scatter-marker-sizeref for more information. Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/#scatter-marker-sizemode to area.
```python
import plotly.graph_objects as go
@@ -208,4 +208,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#choropleth and https://plot.ly/python/reference/#scattergeo for more information and chart attribute options!
+See https://plotly.com/python/reference/#choropleth and https://plotly.com/python/reference/#scattergeo for more information and chart attribute options!
diff --git a/doc/python/bullet-charts.md b/doc/python/bullet-charts.md
index ff2297df4b6..c8ca69af844 100644
--- a/doc/python/bullet-charts.md
+++ b/doc/python/bullet-charts.md
@@ -34,8 +34,8 @@ jupyter:
---
#### Basic Bullet Charts
-Stephen Few's Bullet Chart was invented to replace dashboard [gauges](https://plot.ly/python/gauge-charts/) and meters, combining both types of charts into simple bar charts with qualitative bars (steps), quantitative bar (bar) and performance line (threshold); all into one simple layout.
- Steps typically are broken into several values, which are defined with an array. The bar represent the actual value that a particular variable reached, and the threshold usually indicate a goal point relative to the value achieved by the bar. See [indicator page](https://plot.ly/python/gauge-charts/) for more detail.
+Stephen Few's Bullet Chart was invented to replace dashboard [gauges](https://plotly.com/python/gauge-charts/) and meters, combining both types of charts into simple bar charts with qualitative bars (steps), quantitative bar (bar) and performance line (threshold); all into one simple layout.
+ Steps typically are broken into several values, which are defined with an array. The bar represent the actual value that a particular variable reached, and the threshold usually indicate a goal point relative to the value achieved by the bar. See [indicator page](https://plotly.com/python/gauge-charts/) for more detail.
```python
import plotly.graph_objects as go
@@ -78,7 +78,7 @@ fig.show()
```
#### Custom Bullet
-The following example shows how to customize your charts. For more information about all possible options check our [reference page](https://plot.ly/python/reference/#indicator).
+The following example shows how to customize your charts. For more information about all possible options check our [reference page](https://plotly.com/python/reference/#indicator).
```python
import plotly.graph_objects as go
@@ -167,7 +167,7 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#indicator for more information and chart attribute options!
+See https://plotly.com/python/reference/#indicator for more information and chart attribute options!
```python
diff --git a/doc/python/candlestick-charts.md b/doc/python/candlestick-charts.md
index eeec1a0c311..4f8c48960f2 100644
--- a/doc/python/candlestick-charts.md
+++ b/doc/python/candlestick-charts.md
@@ -144,4 +144,4 @@ fig.show()
```
#### Reference
-For more information on candlestick attributes, see: https://plot.ly/python/reference/#candlestick
+For more information on candlestick attributes, see: https://plotly.com/python/reference/#candlestick
diff --git a/doc/python/carpet-contour.md b/doc/python/carpet-contour.md
index 47cf84347f0..720eb2eadc1 100644
--- a/doc/python/carpet-contour.md
+++ b/doc/python/carpet-contour.md
@@ -37,7 +37,7 @@ jupyter:
### Basic Carpet Plot
-Set the `x` and `y` coorindates, using `x` and `y` attributes. If `x` coorindate values are ommitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plot.ly/python/reference/#carpet-aaxis).
+Set the `x` and `y` coorindates, using `x` and `y` attributes. If `x` coorindate values are ommitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/#carpet-aaxis).
```python
import plotly.graph_objects as go
@@ -286,4 +286,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#contourcarpet for more information and chart attribute options!
+See https://plotly.com/python/reference/#contourcarpet for more information and chart attribute options!
diff --git a/doc/python/carpet-plot.md b/doc/python/carpet-plot.md
index f4f0db30197..5820da84198 100644
--- a/doc/python/carpet-plot.md
+++ b/doc/python/carpet-plot.md
@@ -70,7 +70,7 @@ fig.show()
### Add A and B axis
-Use `aaxis` or `baxis` list to make changes to the axes. For a more detailed list of attributes refer to [R reference](https://plot.ly/r/reference/#carpet-aaxis).
+Use `aaxis` or `baxis` list to make changes to the axes. For a more detailed list of attributes refer to [R reference](https://plotly.com/r/reference/#carpet-aaxis).
```python inputHidden=false outputHidden=false
import plotly.graph_objects as go
@@ -184,9 +184,9 @@ fig.show()
### Add Points and Contours
-To add points and lines see [Carpet Scatter Plots](https://plot.ly/python/carpet-scatter) or to add contours see [Carpet Contour Plots](https://plot.ly/python/carpet-contour)
+To add points and lines see [Carpet Scatter Plots](https://plotly.com/python/carpet-scatter) or to add contours see [Carpet Contour Plots](https://plotly.com/python/carpet-contour)
### Reference
-See https://plot.ly/python/reference/#carpet for more information and chart attribute options!
+See https://plotly.com/python/reference/#carpet for more information and chart attribute options!
diff --git a/doc/python/carpet-scatter.md b/doc/python/carpet-scatter.md
index a2293608aa2..e771cd5d909 100644
--- a/doc/python/carpet-scatter.md
+++ b/doc/python/carpet-scatter.md
@@ -187,4 +187,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#scattercarpet for more information and chart attribute options!
+See https://plotly.com/python/reference/#scattercarpet for more information and chart attribute options!
diff --git a/doc/python/choropleth-maps.md b/doc/python/choropleth-maps.md
index b847966b30c..bd3535e2e6e 100644
--- a/doc/python/choropleth-maps.md
+++ b/doc/python/choropleth-maps.md
@@ -260,7 +260,7 @@ fig.update_layout(
geo = dict(
scope='usa',
projection=go.layout.geo.Projection(type = 'albers usa'),
- showlakes=True, # lakes
+ showlakes=True, # lakes
lakecolor='rgb(255, 255, 255)'),
)
@@ -348,4 +348,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#choropleth for more information and chart attribute options!
+See https://plotly.com/python/reference/#choropleth for more information and chart attribute options!
diff --git a/doc/python/colorscales.md b/doc/python/colorscales.md
index 918c308557c..4fab915e659 100644
--- a/doc/python/colorscales.md
+++ b/doc/python/colorscales.md
@@ -418,7 +418,7 @@ fig.show()
### Setting the Midpoint of a Diverging Color scale with Graph Objects
-The following example uses the [marker.cmid](https://plot.ly/python/reference/#scatter-marker-cmid) attribute to set the mid-point of the color domain by scaling 'cmin' and/or 'cmax' to be equidistant to this point. It only has impact when [marker.color](https://plot.ly/python/reference/#scattercarpet-marker-line-color) sets to a numerical array, and 'marker.cauto' is `True`.
+The following example uses the [marker.cmid](https://plotly.com/python/reference/#scatter-marker-cmid) attribute to set the mid-point of the color domain by scaling 'cmin' and/or 'cmax' to be equidistant to this point. It only has impact when [marker.color](https://plotly.com/python/reference/#scattercarpet-marker-line-color) sets to a numerical array, and 'marker.cauto' is `True`.
```python
import plotly.graph_objects as go
@@ -432,7 +432,7 @@ fig.add_trace(go.Scatter(
fig.show()
```
-The heatmap chart uses [marker.zmid](https://plot.ly/python/reference/#scatter-marker-zmid) attribute to set the mid-point of the color domain.
+The heatmap chart uses [marker.zmid](https://plotly.com/python/reference/#scatter-marker-zmid) attribute to set the mid-point of the color domain.
```python
import plotly.graph_objects as go
@@ -508,7 +508,7 @@ fig.show()
### Sharing a Color Axis with Graph Objects
-To share colorscale information in multiple subplots, you can use [coloraxis](https://plot.ly/javascript/reference/#scatter-marker-line-coloraxis).
+To share colorscale information in multiple subplots, you can use [coloraxis](https://plotly.com/javascript/reference/#scatter-marker-line-coloraxis).
```python
import plotly.graph_objects as go
@@ -558,4 +558,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/compare-webgl-svg.md b/doc/python/compare-webgl-svg.md
index 022fca807cd..62c50ef2483 100644
--- a/doc/python/compare-webgl-svg.md
+++ b/doc/python/compare-webgl-svg.md
@@ -101,5 +101,5 @@ fig.show()
For more information see
-`Scattergl()` : https://plot.ly/python/reference/#scattergl
-`Scatter()` : https://plot.ly/python/reference/#scatter
+`Scattergl()` : https://plotly.com/python/reference/#scattergl
+`Scatter()` : https://plotly.com/python/reference/#scatter
diff --git a/doc/python/cone-plot.md b/doc/python/cone-plot.md
index 0ffcb4aad71..2169d3f2ae5 100644
--- a/doc/python/cone-plot.md
+++ b/doc/python/cone-plot.md
@@ -127,5 +127,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/contour-plots.md b/doc/python/contour-plots.md
index 5a5608cac95..f662d6ec6fb 100644
--- a/doc/python/contour-plots.md
+++ b/doc/python/contour-plots.md
@@ -339,4 +339,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#contour for more information and chart attribute options!
+See https://plotly.com/python/reference/#contour for more information and chart attribute options!
diff --git a/doc/python/county-choropleth.md b/doc/python/county-choropleth.md
index 904eff8fb9b..01ba4b1c549 100644
--- a/doc/python/county-choropleth.md
+++ b/doc/python/county-choropleth.md
@@ -273,7 +273,7 @@ fig.layout.template = None
fig.show()
```
-Also see Mapbox county choropleths made in Python: [https://plot.ly/python/mapbox-county-choropleth/](https://plot.ly/python/mapbox-county-choropleth/)
+Also see Mapbox county choropleths made in Python: [https://plotly.com/python/mapbox-county-choropleth/](https://plotly.com/python/mapbox-county-choropleth/)
#### Reference
diff --git a/doc/python/creating-and-updating-figures.md b/doc/python/creating-and-updating-figures.md
index 89710a448a9..7e7502fa850 100644
--- a/doc/python/creating-and-updating-figures.md
+++ b/doc/python/creating-and-updating-figures.md
@@ -62,7 +62,7 @@ The value of the top-level `"data"` key is a list of trace specifications. Each
The value of the top-level `"layout"` key is a dictionary that specifies the properties of the figure's layout. In contrast to trace configuration options that apply to individual traces, the layout configuration options apply to the figure as a whole, customizing items like the axes, annotations, shapes, legend, and more.
-The [_Full Reference_](https://plot.ly/python/reference/) page contains descriptions of all of the supported trace and layout options.
+The [_Full Reference_](https://plotly.com/python/reference/) page contains descriptions of all of the supported trace and layout options.
If working from the _Full Reference_ to build figures as Python dictionaries and lists suites your needs, go for it! This is a perfectly valid way to use plotly.py to build figures. On the other hand, if you would like an API that offers a bit more assistance, read on to learn about graph objects.
diff --git a/doc/python/cufflinks.md b/doc/python/cufflinks.md
new file mode 100644
index 00000000000..5683bfcd422
--- /dev/null
+++ b/doc/python/cufflinks.md
@@ -0,0 +1,166 @@
+---
+jupyter:
+ jupytext:
+ notebook_metadata_filter: all
+ text_representation:
+ extension: .md
+ format_name: markdown
+ format_version: "1.2"
+ jupytext_version: 1.3.1
+ kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+ language_info:
+ codemirror_mode:
+ name: ipython
+ version: 3
+ file_extension: .py
+ mimetype: text/x-python
+ name: python
+ nbconvert_exporter: python
+ pygments_lexer: ipython3
+ version: 3.6.8
+ plotly:
+ description:
+ Cufflinks is a third-party wrapper library around Plotly, inspired by the Pandas .plot() API.
+ display_as: file_settings
+ language: python
+ layout: base
+ name: Cufflinks
+ order: 31
+ permalink: python/cufflinks/
+ thumbnail: thumbnail/plotly-express.png
+---
+
+### Introduction
+
+[Cufflinks](https://github.com/santosjorge/cufflinks) is a third-party wrapper library around Plotly, maintained by [Santos Jorge](https://github.com/santosjorge).
+
+When you import cufflinks, all [Pandas](https://pandas.pydata.org/) data frames and series objects have a new method attached to them called `.iplot()` which has a similar API to Pandas' built-in `.plot()` method.
+
+By passing the `asFigure=True` argument to `.iplot()`, Cufflinks works similarly to [Plotly Express](/python/plotly-express/), by returning [customizable `go.Figure` objects](/python/styling-plotly-express/) which are compatible with [Dash](https://dash.plot.ly)'s [`dcc.Graph` component](https://dash.plotly.com/dash-core-components/graph). Cufflinks also adds a `.figure()` method which has the same signature as `.iplot()` except that it has `asFigure=True` set as the default.
+
+This page shows some high-level examples of how to use Cufflinks, and more examples and documentation are available in the [Cufflinks Github repository](https://github.com/santosjorge/cufflinks).
+
+> Issues and questions regarding Cufflinks should be [raised in the Cufflinks repository](https://github.com/santosjorge/cufflinks/issues/new).
+
+```python
+import cufflinks as cf
+import pandas as pd
+import numpy as np
+
+df = pd.DataFrame(np.random.randn(1000, 2), columns=['A', 'B']).cumsum()
+fig = df.iplot(asFigure=True, xTitle="The X Axis",
+ yTitle="The Y Axis", title="The Figure Title")
+fig.show()
+```
+
+Cufflinks has a `datagen` module for generating demo data.
+
+```python
+import cufflinks as cf
+
+df = cf.datagen.lines()
+fig = df.iplot(asFigure=True)
+fig.show()
+df.head()
+```
+
+### Scatter Plots
+
+```python
+import cufflinks as cf
+import pandas as pd
+import numpy as np
+
+df = pd.DataFrame(np.random.randn(1000, 2), columns=['A', 'B']).cumsum()
+fig = df.iplot(asFigure=True, x='A', y='B', mode='markers')
+fig.show()
+```
+
+### Bar Charts
+
+```python
+import cufflinks as cf
+import pandas as pd
+df = pd.DataFrame(np.random.rand(10, 4), columns=['A', 'B', 'C', 'D'])
+fig = df.iplot(asFigure=True, kind="bar")
+fig.show()
+```
+
+### Histograms
+
+```python
+import cufflinks as cf
+import pandas as pd
+df = pd.DataFrame({'a': np.random.randn(1000) + 1,
+ 'b': np.random.randn(1000),
+ 'c': np.random.randn(1000) - 1})
+
+fig = df.iplot(asFigure=True, kind="histogram")
+fig.show()
+```
+
+### Box Plots
+
+```python
+import cufflinks as cf
+import pandas as pd
+df = pd.DataFrame({'a': np.random.randn(1000) + 1,
+ 'b': np.random.randn(1000),
+ 'c': np.random.randn(1000) - 1})
+
+fig = df.iplot(asFigure=True, kind="box")
+fig.show()
+```
+
+### Subplots
+
+```python
+import cufflinks as cf
+
+df=cf.datagen.lines(4)
+fig = df.iplot(asFigure=True, subplots=True, shape=(4,1), shared_xaxes=True, fill=True)
+fig.show()
+```
+
+```python
+import cufflinks as cf
+
+df=cf.datagen.lines(4)
+fig = df.iplot(asFigure=True, subplots=True, subplot_titles=True, legend=False)
+fig.show()
+```
+
+### Line and Box Annotations
+
+```python
+import cufflinks as cf
+
+df=cf.datagen.lines(4)
+fig = df.iplot(asFigure=True, hline=[2,4], vline=['2015-02-10'])
+fig.show()
+```
+
+```python
+import cufflinks as cf
+
+df=cf.datagen.lines(4)
+fig = df.iplot(asFigure=True, hspan=[(-1,1),(2,5)])
+fig.show()
+```
+
+```python
+import cufflinks as cf
+
+df=cf.datagen.lines(4)
+fig = df.iplot(asFigure=True,
+ vspan={'x0':'2015-02-15','x1':'2015-03-15',
+ 'color':'rgba(30,30,30,0.3)','fill':True,'opacity':.4})
+fig.show()
+```
+
+### More Examples
+
+More documentation and examples for Cufflinks can be found in its [Github repository](https://github.com/santosjorge/cufflinks).
diff --git a/doc/python/custom-buttons.md b/doc/python/custom-buttons.md
index 33c76ec9218..2b329b0f631 100644
--- a/doc/python/custom-buttons.md
+++ b/doc/python/custom-buttons.md
@@ -34,10 +34,10 @@ jupyter:
---
#### Methods
-The [updatemenu method](https://plot.ly/python/reference/#layout-updatemenus-buttons-method) determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods:
-- `"restyle"`: modify data or data attributes
-- `"relayout"`: modify layout attributes
-- `"update"`: modify data **and** layout attributes
+The [updatemenu method](https://plot.ly/python/reference/#layout-updatemenus-items-updatemenu-buttons-items-button-method) determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods:
+- `"restyle"`: modify **data** or data attributes
+- `"relayout"`: modify **layout** attributes
+- `"update"`: modify **data and layout** attributes; combination of `"restyle"` and `"relayout"`
- `"animate"`: start or pause an [animation](https://plot.ly/python/#animations))
@@ -456,8 +456,8 @@ fig.show()
```
#### Animate Button
-Refer to our animation docs: https://plot.ly/python/#animations for examples on how to use the `animate` method with Plotly buttons.
+Refer to our animation docs: https://plotly.com/python/#animations for examples on how to use the `animate` method with Plotly buttons.
#### Reference
-See https://plot.ly/python/reference/#layout-updatemenus for more information about `updatemenu` buttons.
+See https://plotly.com/python/reference/#layout-updatemenus for more information about `updatemenu` buttons.
diff --git a/doc/python/datashader.md b/doc/python/datashader.md
index 9a9a3ba9f52..aa2c963c966 100644
--- a/doc/python/datashader.md
+++ b/doc/python/datashader.md
@@ -5,8 +5,8 @@ jupyter:
text_representation:
extension: .md
format_name: markdown
- format_version: "1.2"
- jupytext_version: 1.3.1
+ format_version: '1.2'
+ jupytext_version: 1.3.0
kernelspec:
display_name: Python 3
language: python
@@ -20,10 +20,9 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.6.8
+ version: 3.7.3
plotly:
- description:
- How to use datashader to rasterize large datasets, and visualize
+ description: How to use datashader to rasterize large datasets, and visualize
the generated raster data with plotly.
display_as: scientific
language: python
@@ -98,7 +97,7 @@ fig.show()
```
```python
-import plotly.graph_objects as go
+import plotly.express as px
import pandas as pd
import numpy as np
import datashader as ds
@@ -106,22 +105,11 @@ df = pd.read_parquet('https://raw.githubusercontent.com/plotly/datasets/master/2
cvs = ds.Canvas(plot_width=100, plot_height=100)
agg = cvs.points(df, 'SCHEDULED_DEPARTURE', 'DEPARTURE_DELAY')
-x = np.array(agg.coords['SCHEDULED_DEPARTURE'])
-y = np.array(agg.coords['DEPARTURE_DELAY'])
-
-# Assign nan to zero values so that the corresponding pixels are transparent
-agg = np.array(agg.values, dtype=np.float)
-agg[agg<1] = np.nan
-
-fig = go.Figure(go.Heatmap(
- z=np.log10(agg), x=x, y=y,
- hoverongaps=False,
- hovertemplate='Scheduled departure: %{x:.1f}h
Depature delay: %{y}
Log10(Count): %{z}',
- colorbar=dict(title='Count (Log)', tickprefix='1.e')))
-fig.update_xaxes(title_text='Scheduled departure')
-fig.update_yaxes(title_text='Departure delay')
+agg.values = np.log10(agg.values)
+fig = px.imshow(agg, origin='lower', labels={'color':'Log10(count)'})
+fig.update_traces(hoverongaps=False)
+fig.update_layout(coloraxis_colorbar=dict(title='Count', tickprefix='1.e'))
fig.show()
-
```
```python
diff --git a/doc/python/distplot.md b/doc/python/distplot.md
index b2bedfeffbe..1b3f2256fd2 100644
--- a/doc/python/distplot.md
+++ b/doc/python/distplot.md
@@ -35,7 +35,7 @@ jupyter:
## Combined statistical representations with px.histogram
-Several representations of statistical distributions are available in plotly, such as [histograms](https://plot.ly/python/histograms/), [violin plots](https://plot.ly/python/violin/), [box plots](https://plot.ly/python/box-plots/) (see [the complete list here](https://plot.ly/python/statistical-charts/)). It is also possible to combine several representations in the same plot.
+Several representations of statistical distributions are available in plotly, such as [histograms](https://plotly.com/python/histograms/), [violin plots](https://plotly.com/python/violin/), [box plots](https://plotly.com/python/box-plots/) (see [the complete list here](https://plotly.com/python/statistical-charts/)). It is also possible to combine several representations in the same plot.
For example, the `plotly.express` function `px.histogram` can add a subplot with a different statistical representation than the histogram, given by the parameter `marginal`. [Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
diff --git a/doc/python/dot-plots.md b/doc/python/dot-plots.md
index a5aaa6997ee..bb212eb4069 100644
--- a/doc/python/dot-plots.md
+++ b/doc/python/dot-plots.md
@@ -158,4 +158,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#scatter for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter for more information and chart attribute options!
diff --git a/doc/python/dropdowns.md b/doc/python/dropdowns.md
index ca9a77df2e2..12bf1ad3ba5 100644
--- a/doc/python/dropdowns.md
+++ b/doc/python/dropdowns.md
@@ -34,11 +34,11 @@ jupyter:
---
#### Methods
-The [updatemenu method](https://plot.ly/python/reference/#layout-updatemenus-buttons-method) determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods:
+The [updatemenu method](https://plotly.com/python/reference/#layout-updatemenus-buttons-method) determines which [plotly.js function](https://plotly.com/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods:
- `"restyle"`: modify data or data attributes
- `"relayout"`: modify layout attributes
- `"update"`: modify data **and** layout attributes
-- `"animate"`: start or pause an [animation](https://plot.ly/python/#animations)
+- `"animate"`: start or pause an [animation](https://plotly.com/python/#animations)
## Restyle Dropdown
@@ -445,4 +445,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#layout-updatemenus for more information about `updatemenu` dropdowns.
+See https://plotly.com/python/reference/#layout-updatemenus for more information about `updatemenu` dropdowns.
diff --git a/doc/python/error-bars.md b/doc/python/error-bars.md
index 37867c149f6..bd3cf91b6a2 100644
--- a/doc/python/error-bars.md
+++ b/doc/python/error-bars.md
@@ -33,9 +33,9 @@ jupyter:
thumbnail: thumbnail/error-bar.jpg
---
-### Error Bars with Plotly Express
+### Error Bars with Plotly Express
-[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/). For functions representing 2D data points such as [`px.scatter`](https://plot.ly/python/line-and-scatter/), [`px.line`](https://plot.ly/python/line-charts/), [`px.bar`](https://plot.ly/python/bar-charts/) etc., error bars are given as a column name which is the value of the `error_x` (for the error on x position) and `error_y` (for the error on y position).
+[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/). For functions representing 2D data points such as [`px.scatter`](https://plotly.com/python/line-and-scatter/), [`px.line`](https://plotly.com/python/line-charts/), [`px.bar`](https://plotly.com/python/bar-charts/) etc., error bars are given as a column name which is the value of the `error_x` (for the error on x position) and `error_y` (for the error on y position).
```python
import plotly.express as px
@@ -46,7 +46,7 @@ fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species",
fig.show()
```
-#### Asymmetric Error Bars with Plotly Express
+#### Asymmetric Error Bars with Plotly Express
```python
import plotly.express as px
@@ -202,4 +202,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatter for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter for more information and chart attribute options!
diff --git a/doc/python/facet-plots.md b/doc/python/facet-plots.md
index 6df50ae549a..5bfd632fae8 100644
--- a/doc/python/facet-plots.md
+++ b/doc/python/facet-plots.md
@@ -103,7 +103,7 @@ fig.show()
### Customize Subplot Figure Titles
-Since subplot figure titles are [annotations](https://plot.ly/python/text-and-annotations/#simple-annotation), you can use the `for_each_annotation` function to customize them.
+Since subplot figure titles are [annotations](https://plotly.com/python/text-and-annotations/#simple-annotation), you can use the `for_each_annotation` function to customize them.
In the following example, we pass a lambda function to `for_each_annotation` in order to change the figure subplot titles from `smoker=No` and `smoker=Yes` to just `No` and `Yes`.
@@ -121,7 +121,7 @@ fig.show()
### Synchronizing axes in subplots with `matches`
-Using `facet_col` from `plotly.express` let [zoom](https://help.plot.ly/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plot.ly/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
+Using `facet_col` from `plotly.express` let [zoom](https://help.plotly.com/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plotly.com/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
Zoom in one trace below, to see the other subplots zoomed to the same x-axis range. To pan all the subplots, click and drag from the center of x-axis to the side:
diff --git a/doc/python/figure-factory-subplots.md b/doc/python/figure-factory-subplots.md
index 0c34731f249..db946d73b58 100644
--- a/doc/python/figure-factory-subplots.md
+++ b/doc/python/figure-factory-subplots.md
@@ -210,4 +210,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/subplots/ for more information on working with subplots. See https://plot.ly/python/reference/ for more information regarding chart attributes!
+See https://plotly.com/python/subplots/ for more information on working with subplots. See https://plotly.com/python/reference/ for more information regarding chart attributes!
diff --git a/doc/python/figure-labels.md b/doc/python/figure-labels.md
index 0d879357bab..38a3ec7f930 100644
--- a/doc/python/figure-labels.md
+++ b/doc/python/figure-labels.md
@@ -69,7 +69,7 @@ fig.show()
The configuration of the legend is discussed in detail in the [Legends](/python/legend/) page.
### Align Plot Title
-The following example shows how to align the plot title in [layout.title](https://plot.ly/python/reference/#layout-title). `x` sets the x position with respect to `xref` from "0" (left) to "1" (right), and `y` sets the y position with respect to `yref` from "0" (bottom) to "1" (top). Moreover, you can define `xanchor` to `left`,`right`, or `center` for setting the title's horizontal alignment with respect to its x position, and/or `yanchor` to `top`, `bottom`, or `middle` for setting the title's vertical alignment with respect to its y position.
+The following example shows how to align the plot title in [layout.title](https://plotly.com/python/reference/#layout-title). `x` sets the x position with respect to `xref` from "0" (left) to "1" (right), and `y` sets the y position with respect to `yref` from "0" (bottom) to "1" (top). Moreover, you can define `xanchor` to `left`,`right`, or `center` for setting the title's horizontal alignment with respect to its x position, and/or `yanchor` to `top`, `bottom`, or `middle` for setting the title's vertical alignment with respect to its y position.
```python
import plotly.graph_objects as go
@@ -90,4 +90,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#layout for more information!
+See https://plotly.com/python/reference/#layout for more information!
diff --git a/doc/python/filled-area-on-mapbox.md b/doc/python/filled-area-on-mapbox.md
index 7b7ebe982a8..979b9afd6de 100644
--- a/doc/python/filled-area-on-mapbox.md
+++ b/doc/python/filled-area-on-mapbox.md
@@ -41,9 +41,9 @@ To plot on Mapbox maps with Plotly you _may_ need a Mapbox account and a public
There are three different ways to show a filled area in a Mapbox map:
-1. Use a [Scattermapbox](https://plot.ly/python/reference/#scattermapbox) trace and set `fill` attribute to 'toself'
-2. Use a Mapbox layout (i.e. by minimally using an empty [Scattermapbox](https://plot.ly/python/reference/#scattermapbox) trace) and add a GeoJSON layer
-3. Use the [Choroplethmapbox](https://plot.ly/python/mapbox-county-choropleth/) trace type
+1. Use a [Scattermapbox](https://plotly.com/python/reference/#scattermapbox) trace and set `fill` attribute to 'toself'
+2. Use a Mapbox layout (i.e. by minimally using an empty [Scattermapbox](https://plotly.com/python/reference/#scattermapbox) trace) and add a GeoJSON layer
+3. Use the [Choroplethmapbox](https://plotly.com/python/mapbox-county-choropleth/) trace type
### Filled `Scattermapbox` Trace
@@ -70,7 +70,7 @@ fig.show()
### Multiple Filled Areas with a `Scattermapbox` trace
-The following example shows how to use `None` in your data to draw multiple filled areas. Such gaps in trace data are unconnected by default, but this can be controlled via the [connectgaps](https://plot.ly/python/reference/#scattermapbox-connectgaps) attribute.
+The following example shows how to use `None` in your data to draw multiple filled areas. Such gaps in trace data are unconnected by default, but this can be controlled via the [connectgaps](https://plotly.com/python/reference/#scattermapbox-connectgaps) attribute.
```python
import plotly.graph_objects as go
@@ -141,4 +141,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scattermapbox for more information about mapbox and their attribute options.
+See https://plotly.com/python/reference/#scattermapbox for more information about mapbox and their attribute options.
diff --git a/doc/python/filled-area-plots.md b/doc/python/filled-area-plots.md
index f45ca14d143..347fbeb1efb 100644
--- a/doc/python/filled-area-plots.md
+++ b/doc/python/filled-area-plots.md
@@ -70,7 +70,7 @@ import plotly.graph_objects as go
fig = go.Figure()
fig.add_trace(go.Scatter(x=[1, 2, 3, 4], y=[0, 2, 3, 5], fill='tozeroy',
- mode='none' # override default markers+lines
+ mode='none' # override default markers+lines
))
fig.add_trace(go.Scatter(x=[1, 2, 3, 4], y=[3, 5, 1, 7], fill='tonexty',
mode= 'none'))
@@ -92,7 +92,7 @@ fig.add_trace(go.Scatter(x=[1, 2, 3, 4], y=[3, 4, 8, 3],
fig.add_trace(go.Scatter(
x=[1, 2, 3, 4],
y=[1, 6, 2, 6],
- fill='tonexty', # fill area between trace0 and trace1
+ fill='tonexty', # fill area between trace0 and trace1
mode='lines', line_color='indigo'))
fig.show()
@@ -210,6 +210,6 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatter-line
-and https://plot.ly/python/reference/#scatter-fill
+See https://plotly.com/python/reference/#scatter-line
+and https://plotly.com/python/reference/#scatter-fill
for more information and attribute options!
diff --git a/doc/python/filter.md b/doc/python/filter.md
index b1798d1a34f..d3fb6a86886 100644
--- a/doc/python/filter.md
+++ b/doc/python/filter.md
@@ -64,4 +64,4 @@ pio.show(fig_dict, validate=False)
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/funnel-charts.md b/doc/python/funnel-charts.md
index 669b3221f3a..cf9c6898f93 100644
--- a/doc/python/funnel-charts.md
+++ b/doc/python/funnel-charts.md
@@ -74,7 +74,7 @@ fig.show()
### Setting Marker Size and Color
-This example uses [textposition](https://plot.ly/python/reference/#scatter-textposition) and [textinfo](https://plot.ly/python/reference/#funnel-textinfo) to determine information apears on the graph, and shows how to customize the bars.
+This example uses [textposition](https://plotly.com/python/reference/#scatter-textposition) and [textinfo](https://plotly.com/python/reference/#funnel-textinfo) to determine information apears on the graph, and shows how to customize the bars.
```python
from plotly import graph_objects as go
@@ -202,4 +202,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#funnel and https://plot.ly/python/reference/#funnelarea for more information and chart attribute options!
+See https://plotly.com/python/reference/#funnel and https://plotly.com/python/reference/#funnelarea for more information and chart attribute options!
diff --git a/doc/python/gantt.md b/doc/python/gantt.md
index 63df4f0ad28..e63e58f5c96 100644
--- a/doc/python/gantt.md
+++ b/doc/python/gantt.md
@@ -36,7 +36,7 @@ jupyter:
A [Gantt chart](https://en.wikipedia.org/wiki/Gantt_chart) is a type of bar chart that illustrates a project schedule. The chart lists the tasks to be performed on the vertical axis, and time intervals on the horizontal axis. The width of the horizontal bars in the graph shows the duration of each activity.
-See also the [bar charts examples](https://plot.ly/python/bar-charts/).
+See also the [bar charts examples](https://plotly.com/python/bar-charts/).
#### Simple Gantt Chart
diff --git a/doc/python/gauge-charts.md b/doc/python/gauge-charts.md
index ad0167e2e4b..0d6ba38127a 100644
--- a/doc/python/gauge-charts.md
+++ b/doc/python/gauge-charts.md
@@ -41,7 +41,7 @@ A radial gauge chart has a circular arc, which displays a single value to estima
The bar shows the target value, and the shading represents the progress toward that goal. Gauge charts, known as
speedometer charts as well. This chart type is usually used to illustrate key business indicators.
- The example below displays a basic gauge chart with default attributes. For more information about different added attributes check [indicator](https://plot.ly/python/indicator/) tutorial.
+ The example below displays a basic gauge chart with default attributes. For more information about different added attributes check [indicator](https://plotly.com/python/indicator/) tutorial.
```python
import plotly.graph_objects as go
@@ -78,7 +78,7 @@ fig.show()
```
#### Custom Gauge Chart
-The following example shows how to style your gauge charts. For more information about all possible options check our [reference page](https://plot.ly/python/reference/#indicator).
+The following example shows how to style your gauge charts. For more information about all possible options check our [reference page](https://plotly.com/python/reference/#indicator).
```python
import plotly.graph_objects as go
@@ -110,4 +110,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#indicator for more information and chart attribute options!
+See https://plotly.com/python/reference/#indicator for more information and chart attribute options!
diff --git a/doc/python/getting-started.md b/doc/python/getting-started.md
index 157f91a45c2..5d44383c434 100644
--- a/doc/python/getting-started.md
+++ b/doc/python/getting-started.md
@@ -38,9 +38,9 @@ jupyter:
### Overview
-The plotly Python library ([plotly.py](https://plot.ly/python/)) is an interactive, [open-source](https://github.com/plotly/plotly.py) plotting library that supports over 40 unique chart types covering a wide range of statistical, financial, geographic, scientific, and 3-dimensional use-cases.
+The plotly Python library ([plotly.py](https://plotly.com/python/)) is an interactive, [open-source](https://github.com/plotly/plotly.py) plotting library that supports over 40 unique chart types covering a wide range of statistical, financial, geographic, scientific, and 3-dimensional use-cases.
-Built on top of the Plotly JavaScript library ([plotly.js](https://plot.ly/javascript/)), plotly.py enables Python users to create beautiful interactive web-based visualizations that can be displayed in Jupyter notebooks, saved to standalone HTML files, or served as part of pure Python-built web applications using Dash.
+Built on top of the Plotly JavaScript library ([plotly.js](https://plotly.com/javascript/)), plotly.py enables Python users to create beautiful interactive web-based visualizations that can be displayed in Jupyter notebooks, saved to standalone HTML files, or served as part of pure Python-built web applications using Dash.
Thanks to deep integration with the [orca](https://github.com/plotly/orca) image export utility, plotly.py also provides great support for non-web contexts including desktop editors (e.g. QtConsole, Spyder, PyCharm) and static document publishing (e.g. exporting notebooks to PDF with high-quality vector images).
@@ -49,13 +49,13 @@ Thanks to deep integration with the [orca](https://github.com/plotly/orca) image
plotly.py may be installed using pip...
```
-$ pip install plotly==4.5.3
+$ pip install plotly==4.5.4
```
or conda.
```
-$ conda install -c plotly plotly=4.5.3
+$ conda install -c plotly plotly=4.5.4
```
This package contains everything you need to write figures to standalone HTML files.
@@ -144,10 +144,10 @@ set NODE_OPTIONS=--max-old-space-size=4096
jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1 --no-build
# jupyterlab renderer support
-jupyter labextension install jupyterlab-plotly@1.5.3 --no-build
+jupyter labextension install jupyterlab-plotly@1.5.4 --no-build
# FigureWidget support
-jupyter labextension install plotlywidget@1.5.3 --no-build
+jupyter labextension install plotlywidget@1.5.4 --no-build
# Build extensions (must be done to activate extensions since --no-build is used above)
jupyter lab build
@@ -199,7 +199,7 @@ installation of the plotly [orca](https://github.com/plotly/orca) command line u
These dependencies can all be installed using conda:
```
-$ conda install -c plotly plotly-orca psutil requests
+$ conda install -c plotly plotly-orca==1.2.1 psutil requests
```
Or, `psutil` and `requests` can be installed using pip...
@@ -240,7 +240,7 @@ or conda.
$ conda install -c plotly plotly-geo=1.0.0
```
-See [_USA County Choropleth Maps in Python_](https://plot.ly/python/county-choropleth/) for more information on the county choropleth figure factory.
+See [_USA County Choropleth Maps in Python_](https://plotly.com/python/county-choropleth/) for more information on the county choropleth figure factory.
#### Chart Studio Support
@@ -271,8 +271,8 @@ For information on theming plotly figures, see [_Theming and templates with plot
For information on all of the ways that plotly figures can be displayed, see [_Displaying plotly figures with plotly for Python_](/python/renderers/).
-For the full searchable reference of every figure property, see the [_Python figure reference_](https://plot.ly/python/reference/).
+For the full searchable reference of every figure property, see the [_Python figure reference_](https://plotly.com/python/reference/).
-For information on using Python to build web applications containing plotly figures, see the [_Dash User Guide_](https://dash.plot.ly/).
+For information on using Python to build web applications containing plotly figures, see the [_Dash User Guide_](https://dash.plotly.com/).
diff --git a/doc/python/graphing-multiple-chart-types.md b/doc/python/graphing-multiple-chart-types.md
index 12d8231dc86..118e1c6a616 100644
--- a/doc/python/graphing-multiple-chart-types.md
+++ b/doc/python/graphing-multiple-chart-types.md
@@ -98,4 +98,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/ for more information and attribute options!
+See https://plotly.com/python/reference/ for more information and attribute options!
diff --git a/doc/python/group-by.md b/doc/python/group-by.md
index 0d927e6a4de..ac9d1464523 100644
--- a/doc/python/group-by.md
+++ b/doc/python/group-by.md
@@ -62,4 +62,4 @@ pio.show(fig_dict, validate=False)
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/heatmaps.md b/doc/python/heatmaps.md
index ec2735bf725..a4d401698fb 100644
--- a/doc/python/heatmaps.md
+++ b/doc/python/heatmaps.md
@@ -36,9 +36,7 @@ jupyter:
### Heatmap with `plotly.express` and `px.imshow`
-[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly. With `px.imshow`, each value of the input array is represented as a heatmap pixel.
-
-`px.imshow` makes opiniated choices for representing heatmaps, such as using square pixels. To override this behaviour, you can use `fig.update_layout` or use the `go.Heatmap` trace from `plotly.graph_objects` as described below.
+[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/). With `px.imshow`, each value of the input array is represented as a heatmap pixel.
For more examples using `px.imshow`, see the [tutorial on displaying image data with plotly](/python/imshow).
@@ -51,6 +49,22 @@ fig = px.imshow([[1, 20, 30],
fig.show()
```
+### Customizing the axes and labels on a heatmap
+
+You can use the `x`, `y` and `labels` arguments to customize the display of a heatmap, and use `.update_xaxes()` to move the x axis tick labels to the top:
+
+```python
+import plotly.express as px
+data=[[1, 25, 30, 50, 1], [20, 1, 60, 80, 30], [30, 60, 1, 5, 20]]
+fig = px.imshow(data,
+ labels=dict(x="Day of Week", y="Time of Day", color="Productivity"),
+ x=['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ y=['Morning', 'Afternoon', 'Evening']
+ )
+fig.update_xaxes(side="top")
+fig.show()
+```
+
### Basic Heatmap with `plotly.graph_objects`
If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Heatmap` function from `plotly.graph_objects`.
@@ -67,7 +81,7 @@ fig.show()
### Heatmap with Categorical Axis Labels
-In this example we also show how to ignore [hovertext](https://plot.ly/python/hover-text-and-formatting/) when we have [missing values](https://plot.ly/python/missing_values) in the data by setting the [hoverongaps](https://plot.ly/python/reference/#heatmap-hoverongaps) to False.
+In this example we also show how to ignore [hovertext](https://plotly.com/python/hover-text-and-formatting/) when we have [missing values](https://plotly.com/python/missing_values) in the data by setting the [hoverongaps](https://plotly.com/python/reference/#heatmap-hoverongaps) to False.
```python
import plotly.graph_objects as go
@@ -168,4 +182,4 @@ Arrays of rasterized values build by datashader can be visualized using
plotly's heatmaps, as shown in the [plotly and datashader tutorial](/python/datashader/).
#### Reference
-See https://plot.ly/python/reference/#heatmap for more information and chart attribute options!
+See https://plotly.com/python/reference/#heatmap for more information and chart attribute options!
diff --git a/doc/python/histograms.md b/doc/python/histograms.md
index 76bc94d1d7d..7227e1d9ac3 100644
--- a/doc/python/histograms.md
+++ b/doc/python/histograms.md
@@ -69,6 +69,23 @@ fig = px.histogram(df, x="total_bill", nbins=20)
fig.show()
```
+#### Accessing the counts (y-axis) values
+
+JavaScript calculates the y-axis (count) values on the fly in the browser, so it's not accessible in the `fig`. You can manually calculate it using `np.histogram`.
+
+```python
+import plotly.express as px
+import numpy as np
+
+df = px.data.tips()
+# create the bins
+counts, bins = np.histogram(df.total_bill, bins=range(0, 60, 5))
+bins = 0.5 * (bins[:-1] + bins[1:])
+
+fig = px.bar(x=bins, y=counts, labels={'x':'total_bill', 'y':'count'})
+fig.show()
+```
+
#### Type of normalization
The default mode is to represent the count of samples in each bin. With the `histnorm` argument, it is also possible to represent the percentage or fraction of samples in each bin (`histnorm='percent'` or `probability`), or a density histogram (the sum of bars is equal to 100, `density`), or a probability density histogram (sum equal to 1, `probability density`).
@@ -117,7 +134,7 @@ fig.show()
#### Visualizing the distribution
-With the `marginal` keyword, a subplot is drawn alongside the histogram, visualizing the distribution. See [the distplot page](https://plot.ly/python/distplot/)for more examples of combined statistical representations.
+With the `marginal` keyword, a subplot is drawn alongside the histogram, visualizing the distribution. See [the distplot page](https://plotly.com/python/distplot/)for more examples of combined statistical representations.
```python
import plotly.express as px
@@ -129,7 +146,7 @@ fig.show()
## Histograms with go.Histogram
-If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Histogram` from `plotly.graph_objects`. All of the available histogram options are described in the histogram section of the reference page: https://plot.ly/python/reference#histogram.
+If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Histogram` from `plotly.graph_objects`. All of the available histogram options are described in the histogram section of the reference page: https://plotly.com/python/reference#histogram.
### Basic Histogram
@@ -227,7 +244,7 @@ fig.add_trace(go.Histogram(
x=x0,
histnorm='percent',
name='control', # name used in legend and hover labels
- xbins=dict( # bins used for histogram
+ xbins=dict( # bins used for histogram
start=-4.0,
end=3.0,
size=0.5
@@ -249,10 +266,10 @@ fig.add_trace(go.Histogram(
))
fig.update_layout(
- title_text='Sampled Results', # title of plot
+ title_text='Sampled Results', # title of plot
xaxis_title_text='Value', # xaxis label
yaxis_title_text='Count', # yaxis label
- bargap=0.2, # gap between bars of adjacent location coordinates
+ bargap=0.2, # gap between bars of adjacent location coordinates
bargroupgap=0.1 # gap between bars of the same location coordinates
)
@@ -289,7 +306,7 @@ fig.show()
### Custom Binning
-For custom binning along x-axis, use the attribute [`nbinsx`](https://plot.ly/python/reference/#histogram-nbinsx). Please note that the autobin algorithm will choose a 'nice' round bin size that may result in somewhat fewer than `nbinsx` total bins. Alternatively, you can set the exact values for [`xbins`](https://plot.ly/python/reference/#histogram-xbins) along with `autobinx = False`.
+For custom binning along x-axis, use the attribute [`nbinsx`](https://plotly.com/python/reference/#histogram-nbinsx). Please note that the autobin algorithm will choose a 'nice' round bin size that may result in somewhat fewer than `nbinsx` total bins. Alternatively, you can set the exact values for [`xbins`](https://plotly.com/python/reference/#histogram-xbins) along with `autobinx = False`.
```python
import plotly.graph_objects as go
@@ -321,7 +338,7 @@ trace5 = go.Histogram(x=x,
xbins=dict(
start='1969-11-15',
end='1972-03-31',
- size= 'M2'), # 2 months
+ size= 'M2'), # 2 months
autobinx = False
)
@@ -352,7 +369,7 @@ fig2.show()
### Share bins between histograms
-In this example both histograms have a compatible bin settings using [bingroup](https://plot.ly/python/reference/#histogram-bingroup) attribute. Note that traces on the same subplot, and with the same `barmode` ("stack", "relative", "group") are forced into the same `bingroup`, however traces with `barmode = "overlay"` and on different axes (of the same axis type) can have compatible bin settings. Histogram and [histogram2d](https://plot.ly/python/2D-Histogram/) trace can share the same `bingroup`.
+In this example both histograms have a compatible bin settings using [bingroup](https://plotly.com/python/reference/#histogram-bingroup) attribute. Note that traces on the same subplot, and with the same `barmode` ("stack", "relative", "group") are forced into the same `bingroup`, however traces with `barmode = "overlay"` and on different axes (of the same axis type) can have compatible bin settings. Histogram and [histogram2d](https://plotly.com/python/2D-Histogram/) trace can share the same `bingroup`.
```python
import plotly.graph_objects as go
@@ -375,4 +392,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#histogram for more information and chart attribute options!
+See https://plotly.com/python/reference/#histogram for more information and chart attribute options!
diff --git a/doc/python/horizontal-bar-charts.md b/doc/python/horizontal-bar-charts.md
index b9daa15e407..d80525f3c58 100644
--- a/doc/python/horizontal-bar-charts.md
+++ b/doc/python/horizontal-bar-charts.md
@@ -33,7 +33,7 @@ jupyter:
thumbnail: thumbnail/horizontal-bar.jpg
---
-See more examples of bar charts (including vertical bar charts) and styling options [here](https://plot.ly/python/bar-charts/).
+See more examples of bar charts (including vertical bar charts) and styling options [here](https://plotly.com/python/bar-charts/).
### Horizontal Bar Chart with Plotly Express
@@ -64,7 +64,7 @@ fig.show()
### Horizontal Bar Chart with go.Bar
-When data are not available as a tidy dataframe, you can use the more generic function `go.Bar` from `plotly.graph_objects`. All the options of `go.Bar` are documented in the reference https://plot.ly/python/reference/#bar
+When data are not available as a tidy dataframe, you can use the more generic function `go.Bar` from `plotly.graph_objects`. All the options of `go.Bar` are documented in the reference https://plotly.com/python/reference/#bar
#### Basic Horizontal Bar Chart
@@ -335,4 +335,4 @@ fig.show()
### Reference
-See more examples of bar charts and styling options [here](https://plot.ly/python/bar-charts/).
See https://plot.ly/python/reference/#bar for more information and chart attribute options!
+See more examples of bar charts and styling options [here](https://plotly.com/python/bar-charts/).
See https://plotly.com/python/reference/#bar for more information and chart attribute options!
diff --git a/doc/python/hover-text-and-formatting.md b/doc/python/hover-text-and-formatting.md
index 585a61f746b..ca645b46d79 100644
--- a/doc/python/hover-text-and-formatting.md
+++ b/doc/python/hover-text-and-formatting.md
@@ -103,10 +103,10 @@ fig.show()
### Customize tooltip text with a hovertemplate
-To customize the tooltip on your graph you can use [hovertemplate](https://plot.ly/python/reference/#pie-hovertemplate), which is a template string used for rendering the information that appear on hoverbox.
+To customize the tooltip on your graph you can use [hovertemplate](https://plotly.com/python/reference/#pie-hovertemplate), which is a template string used for rendering the information that appear on hoverbox.
This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format).
-Hovertemplate customize the tooltip text vs. [texttemplate](https://plot.ly/python/reference/#pie-texttemplate) which customizes the text that appears on your chart.
-Set the horizontal alignment of the text within tooltip with [hoverlabel.align](https://plot.ly/python/reference/#layout-hoverlabel-align).
+Hovertemplate customize the tooltip text vs. [texttemplate](https://plotly.com/python/reference/#pie-texttemplate) which customizes the text that appears on your chart.
+Set the horizontal alignment of the text within tooltip with [hoverlabel.align](https://plotly.com/python/reference/#layout-hoverlabel-align).
```python
import plotly.graph_objects as go
@@ -150,7 +150,7 @@ fig.show()
### Advanced Hover Template
-The following example shows how to format hover template. [Here](https://plot.ly/python/v3/hover-text-and-formatting/#dash-example) is an example to see how to format hovertemplate in Dash.
+The following example shows how to format hover template. [Here](https://plotly.com/python/v3/hover-text-and-formatting/#dash-example) is an example to see how to format hovertemplate in Dash.
```python
import plotly.graph_objects as go
@@ -260,4 +260,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/images.md b/doc/python/images.md
index d20d6c3b05a..e00b49f7d8b 100644
--- a/doc/python/images.md
+++ b/doc/python/images.md
@@ -56,7 +56,7 @@ fig.add_trace(
# Add images
fig.add_layout_image(
dict(
- source="https://images.plot.ly/language-icons/api-home/python-logo.png",
+ source="https://images.plotly.com/language-icons/api-home/python-logo.png",
xref="x",
yref="y",
x=0,
@@ -75,7 +75,7 @@ fig.show()
```
#### Add a Logo
-See more examples of [adding logos to charts](https://plot.ly/python/logos/)!
+See more examples of [adding logos to charts](https://plotly.com/python/logos/)!
```python
import plotly.graph_objects as go
@@ -301,9 +301,9 @@ fig.update_layout(
)
# Disable the autosize on double click because it adds unwanted margins around the image
-# More detail: https://plot.ly/python/configuration-options/
+# More detail: https://plotly.com/python/configuration-options/
fig.show(config={'doubleClick': 'reset'})
```
#### Reference
-See https://plot.ly/python/reference/#layout-images for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-images for more information and chart attribute options!
diff --git a/doc/python/imshow.md b/doc/python/imshow.md
index ba5b0c20cb7..41914363dc9 100644
--- a/doc/python/imshow.md
+++ b/doc/python/imshow.md
@@ -6,7 +6,7 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.2'
- jupytext_version: 1.3.0
+ jupytext_version: 1.3.1
kernelspec:
display_name: Python 3
language: python
@@ -20,7 +20,7 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.7.3
+ version: 3.6.8
plotly:
description: How to display image data in Python with Plotly.
display_as: scientific
@@ -74,7 +74,7 @@ fig = px.imshow(img)
fig.show()
```
-### Display single-channel 2D image as grayscale
+### Display single-channel 2D data as a heatmap
For a 2D image, `px.imshow` uses a colorscale to map scalar data to colors. The default colorscale is the one of the active template (see [the tutorial on templates](/python/templates/)).
@@ -88,6 +88,17 @@ fig.show()
### Choose the colorscale to display a single-channel image
+You can customize the [continuous color scale](/python/colorscales/) just like with any other Plotly Express function:
+
+```python
+import plotly.express as px
+import numpy as np
+img = np.arange(100).reshape((10, 10))
+fig = px.imshow(img, color_continuous_scale='Viridis')
+fig.show()
+```
+
+You can use this to make the image grayscale as well:
```python
import plotly.express as px
@@ -97,9 +108,9 @@ fig = px.imshow(img, color_continuous_scale='gray')
fig.show()
```
-### Hiding the colorbar when displaying a single-channel image
+### Hiding the colorbar and axis labels
-See [the tutorial on coloraxis](/python/colorscales/#share-color-axis) for more details on coloraxis.
+See the [continuous color](/python/colorscales/) and [cartesian axes](/python/axes/) pages for more details.
```python
import plotly.express as px
@@ -107,6 +118,50 @@ from skimage import data
img = data.camera()
fig = px.imshow(img, color_continuous_scale='gray')
fig.update_layout(coloraxis_showscale=False)
+fig.update_xaxes(showticklabels=False)
+fig.update_yaxes(showticklabels=False)
+fig.show()
+```
+
+### Customizing the axes and labels on a single-channel image
+
+You can use the `x`, `y` and `labels` arguments to customize the display of a heatmap, and use `.update_xaxes()` to move the x axis tick labels to the top:
+
+```python
+import plotly.express as px
+data=[[1, 25, 30, 50, 1], [20, 1, 60, 80, 30], [30, 60, 1, 5, 20]]
+fig = px.imshow(data,
+ labels=dict(x="Day of Week", y="Time of Day", color="Productivity"),
+ x=['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+ y=['Morning', 'Afternoon', 'Evening']
+ )
+fig.update_xaxes(side="top")
+fig.show()
+```
+
+### Display an xarray image with px.imshow
+
+[xarrays](http://xarray.pydata.org/en/stable/) are labeled arrays (with labeled axes and coordinates). If you pass an xarray image to `px.imshow`, its axes labels and coordinates will be used for axis titles. If you don't want this behavior, you can pass `img.values` which is a NumPy array if `img` is an xarray. Alternatively, you can override axis titles hover labels and colorbar title using the `labels` attribute, as above.
+
+```python
+import plotly.express as px
+import xarray as xr
+# Load xarray from dataset included in the xarray tutorial
+airtemps = xr.tutorial.open_dataset('air_temperature').air.sel(lon=250.0)
+fig = px.imshow(airtemps.T, color_continuous_scale='RdBu_r', origin='lower')
+fig.show()
+```
+
+### Display an xarray image with square pixels
+
+For xarrays, by default `px.imshow` does not constrain pixels to be square, since axes often correspond to different physical quantities (e.g. time and space), contrary to a plain camera image where pixels are square (most of the time). If you want to impose square pixels, set the parameter `aspect` to "equal" as below.
+
+```python
+import plotly.express as px
+import xarray as xr
+airtemps = xr.tutorial.open_dataset('air_temperature').air.isel(time=500)
+colorbar_title = airtemps.attrs['var_desc'] + '
(%s)'%airtemps.attrs['units']
+fig = px.imshow(airtemps, color_continuous_scale='RdBu_r', aspect='equal')
fig.show()
```
@@ -141,7 +196,7 @@ img = data.astronaut()
# Increase contrast by clipping the data range between 50 and 200
fig = px.imshow(img, zmin=50, zmax=200)
# We customize the hovertemplate to show both the data and the color values
-# See https://plot.ly/python/hover-text-and-formatting/#customize-tooltip-text-with-a-hovertemplate
+# See https://plotly.com/python/hover-text-and-formatting/#customize-tooltip-text-with-a-hovertemplate
fig.update_traces(hovertemplate="x: %{x}
y: %{y}
z: %{z}
color: %{color}")
fig.show()
```
@@ -201,10 +256,10 @@ fig.show()
### imshow and datashader
Arrays of rasterized values build by datashader can be visualized using
-imshow. See the [plotly and datashader tutorial](/python/datashader/) for
+imshow. See the [plotly and datashader tutorial](/python/datashader/) for
examples on how to use plotly and datashader.
#### Reference
-See https://plot.ly/python/reference/#image for more information and chart attribute options!
+See https://plotly.com/python/reference/#image for more information and chart attribute options!
diff --git a/doc/python/indicator.md b/doc/python/indicator.md
index 2bd0ad5bafd..a695045b20b 100644
--- a/doc/python/indicator.md
+++ b/doc/python/indicator.md
@@ -63,7 +63,7 @@ In this tutorial we introduce a new trace named "Indicator". The purpose of "ind
position: position relative to `number` (either top, left, bottom, right)
Finally, we can have a simple title for the indicator via `title` with 'text' attribute which is a string, and 'align' which can be set to left, center, and right.
- There are two gauge types: [angular](https://plot.ly/python/gauge-charts/) and [bullet](https://plot.ly/python/bullet-charts/). Here is a combination of both shapes (angular, bullet), and different modes (guage, delta, and value):
+ There are two gauge types: [angular](https://plotly.com/python/gauge-charts/) and [bullet](https://plotly.com/python/bullet-charts/). Here is a combination of both shapes (angular, bullet), and different modes (guage, delta, and value):
```python
import plotly.graph_objects as go
@@ -202,7 +202,7 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#indicator for more information and chart attribute options!
+See https://plotly.com/python/reference/#indicator for more information and chart attribute options!
```python
diff --git a/doc/python/legend.md b/doc/python/legend.md
index d11c58305a3..f8840b4c922 100644
--- a/doc/python/legend.md
+++ b/doc/python/legend.md
@@ -268,7 +268,7 @@ fig.show()
#### Size of Legend Items
-In this example [itemsizing](https://plot.ly/python/reference/#layout-legend-itemsizing) attribute determines the legend items symbols remain constant, regardless of how tiny/huge the bubbles would be in the graph.
+In this example [itemsizing](https://plotly.com/python/reference/#layout-legend-itemsizing) attribute determines the legend items symbols remain constant, regardless of how tiny/huge the bubbles would be in the graph.
```python
import plotly.graph_objects as go
@@ -434,4 +434,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#layout-legend for more information!
+See https://plotly.com/python/reference/#layout-legend for more information!
diff --git a/doc/python/line-and-scatter.md b/doc/python/line-and-scatter.md
index 42c46606d9f..1bd9fe4fdcd 100644
--- a/doc/python/line-and-scatter.md
+++ b/doc/python/line-and-scatter.md
@@ -38,7 +38,7 @@ jupyter:
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
-With `px.scatter`, each data point is represented as a marker point, which location is given by the `x` and `y` columns.
+With `px.scatter`, each data point is represented as a marker point, whose location is given by the `x` and `y` columns.
```python
# x and y given as array_like objects
@@ -88,7 +88,7 @@ fig.show()
## Scatter and line plot with go.Scatter
-If Plotly Express does not provide a good starting point, it is possible to use the more generic `go.Scatter` function from `plotly.graph_objects`. Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plot.ly/python/reference/#scatter).
+If Plotly Express does not provide a good starting point, it is possible to use the more generic `go.Scatter` function from `plotly.graph_objects`. Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plotly.com/python/reference/#scatter).
#### Simple Scatter Plot
@@ -107,7 +107,7 @@ fig.show()
#### Line and Scatter Plots
-Use `mode` argument to choose between markers, lines, or a combination of both. For more options about line plots, see also the [line charts notebook](https://plot.ly/python/line-charts/) and the [filled area plots notebook](https://plot.ly/python/filled-area-plots/).
+Use `mode` argument to choose between markers, lines, or a combination of both. For more options about line plots, see also the [line charts notebook](https://plotly.com/python/line-charts/) and the [filled area plots notebook](https://plotly.com/python/filled-area-plots/).
```python
import plotly.graph_objects as go
@@ -140,7 +140,7 @@ fig.show()
#### Bubble Scatter Plots
-In [bubble charts](https://en.wikipedia.org/wiki/Bubble_chart), a third dimension of the data is shown through the size of markers. For more examples, see the [bubble chart notebook](https://plot.ly/python/bubble-charts/)
+In [bubble charts](https://en.wikipedia.org/wiki/Bubble_chart), a third dimension of the data is shown through the size of markers. For more examples, see the [bubble chart notebook](https://plotly.com/python/bubble-charts/)
```python
import plotly.graph_objects as go
@@ -276,4 +276,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#scatter or https://plot.ly/python/reference/#scattergl for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter or https://plotly.com/python/reference/#scattergl for more information and chart attribute options!
diff --git a/doc/python/line-charts.md b/doc/python/line-charts.md
index 7f9313a0ea3..31c11a8dfab 100644
--- a/doc/python/line-charts.md
+++ b/doc/python/line-charts.md
@@ -39,7 +39,7 @@ jupyter:
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/). With `px.line`, each data point is represented as a vertex (which location is given by the `x` and `y` columns) of a **polyline mark** in 2D space.
-For more examples of line plots, see the [line and scatter notebook](https://plot.ly/python/line-and-scatter/).
+For more examples of line plots, see the [line and scatter notebook](https://plotly.com/python/line-and-scatter/).
#### Simple Line Plot with plotly.express
@@ -70,9 +70,9 @@ fig = px.line(df, x="year", y="lifeExp", color="continent",
fig.show()
```
-### Line Plot with go.Scatter
+### Line Plot with go.Scatter
-If Plotly Express does not provide a good starting point, it is possible to use the more generic `go.Scatter` function from `plotly.graph_objects`. Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plot.ly/python/reference/#scatter).
+If Plotly Express does not provide a good starting point, it is possible to use the more generic `go.Scatter` function from `plotly.graph_objects`. Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plotly.com/python/reference/#scatter).
#### Simple Line Plot
@@ -161,7 +161,7 @@ fig.show()
#### Connect Data Gaps
-[connectgaps](https://plot.ly/python/reference/#scatter-connectgaps) determines if missing values in the provided data are shown as a gap in the graph or not. In [this tutorial](https://plot.ly/python/filled-area-on-mapbox/#multiple-filled-areas-with-a-scattermapbox-trace), we showed how to take benefit of this feature and illustrate multiple areas in mapbox.
+[connectgaps](https://plotly.com/python/reference/#scatter-connectgaps) determines if missing values in the provided data are shown as a gap in the graph or not. In [this tutorial](https://plotly.com/python/filled-area-on-mapbox/#multiple-filled-areas-with-a-scattermapbox-trace), we showed how to take benefit of this feature and illustrate multiple areas in mapbox.
```python
import plotly.graph_objects as go
@@ -408,4 +408,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatter for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter for more information and chart attribute options!
diff --git a/doc/python/lines-on-mapbox.md b/doc/python/lines-on-mapbox.md
index 7f72184756d..cbee7bc0a46 100644
--- a/doc/python/lines-on-mapbox.md
+++ b/doc/python/lines-on-mapbox.md
@@ -37,7 +37,7 @@ jupyter:
To plot on Mapbox maps with Plotly you _may_ need a Mapbox account and a public [Mapbox Access Token](https://www.mapbox.com/studio). See our [Mapbox Map Layers](/python/mapbox-layers/) documentation for more information.
-To draw a line on your map, you either can use [`px.line_mapbox()`](https://www.plotly.express/plotly_express/#plotly_express.line_mapbox) in Plotly Express, or [`Scattermapbox`](https://plot.ly/python/reference/#scattermapbox) traces. Below we show you how to draw a line on Mapbox using Plotly Express.
+To draw a line on your map, you either can use [`px.line_mapbox()`](https://www.plotly.express/plotly_express/#plotly_express.line_mapbox) in Plotly Express, or [`Scattermapbox`](https://plotly.com/python/reference/#scattermapbox) traces. Below we show you how to draw a line on Mapbox using Plotly Express.
### Lines on Mapbox maps using Plotly Express
@@ -60,7 +60,7 @@ fig.show()
### Lines on Mapbox maps using `Scattermapbox` traces
This example uses `go.Scattermapbox` and sets
-the [mode](https://plot.ly/python/reference/#scattermapbox-mode) attribute to a combination of markers and line.
+the [mode](https://plotly.com/python/reference/#scattermapbox-mode) attribute to a combination of markers and line.
```python
import plotly.graph_objects as go
@@ -90,4 +90,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scattermapbox for more information about mapbox and their attribute options.
+See https://plotly.com/python/reference/#scattermapbox for more information about mapbox and their attribute options.
diff --git a/doc/python/lines-on-maps.md b/doc/python/lines-on-maps.md
index 87389a28631..eb0510d114f 100644
--- a/doc/python/lines-on-maps.md
+++ b/doc/python/lines-on-maps.md
@@ -52,7 +52,7 @@ fig = px.line_geo(df, locations="iso_alpha",
fig.show()
```
-## Lines on Maps with plotly.graph_objects
+## Lines on Maps with plotly.graph_objects
### US Flight Paths Map
@@ -215,4 +215,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scattergeo for more information and chart attribute options!
+See https://plotly.com/python/reference/#scattergeo for more information and chart attribute options!
diff --git a/doc/python/log-plot.md b/doc/python/log-plot.md
index 12caec57977..d649da7a693 100644
--- a/doc/python/log-plot.md
+++ b/doc/python/log-plot.md
@@ -54,5 +54,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#layout-xaxis-type for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-xaxis-type for more information and chart attribute options!
diff --git a/doc/python/map-configuration.md b/doc/python/map-configuration.md
index 36e5439dbe2..5bd29ead005 100644
--- a/doc/python/map-configuration.md
+++ b/doc/python/map-configuration.md
@@ -220,7 +220,7 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#layout-geo for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-geo for more information and chart attribute options!
```python
diff --git a/doc/python/map-subplots-and-small-multiples.md b/doc/python/map-subplots-and-small-multiples.md
index 706fab0d77f..89c51085645 100644
--- a/doc/python/map-subplots-and-small-multiples.md
+++ b/doc/python/map-subplots-and-small-multiples.md
@@ -162,5 +162,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#scattergeo for more information and chart attribute options!
+See https://plotly.com/python/reference/#scattergeo for more information and chart attribute options!
diff --git a/doc/python/mapbox-county-choropleth.md b/doc/python/mapbox-county-choropleth.md
index 10b26e914b1..a6d73afe769 100644
--- a/doc/python/mapbox-county-choropleth.md
+++ b/doc/python/mapbox-county-choropleth.md
@@ -210,4 +210,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#choroplethmapbox for more information about mapbox and their attribute options.
+See https://plotly.com/python/reference/#choroplethmapbox for more information about mapbox and their attribute options.
diff --git a/doc/python/mapbox-density-heatmaps.md b/doc/python/mapbox-density-heatmaps.md
index 7c4535e22b4..ab96b9fd3c0 100644
--- a/doc/python/mapbox-density-heatmaps.md
+++ b/doc/python/mapbox-density-heatmaps.md
@@ -72,4 +72,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#densitymapbox for more information about mapbox and their attribute options.
+See https://plotly.com/python/reference/#densitymapbox for more information about mapbox and their attribute options.
diff --git a/doc/python/mapbox-layers.md b/doc/python/mapbox-layers.md
index ecb68d5cf3b..35a2ebbdb0a 100644
--- a/doc/python/mapbox-layers.md
+++ b/doc/python/mapbox-layers.md
@@ -56,7 +56,7 @@ Mapbox tile maps are composed of various layers, of three different types:
#### Mapbox Access Tokens and When You Need Them
-The word "mapbox" in the trace names and `layout.mapbox` refers to the Mapbox.js open-source library, which is integrated into Plotly.py. If your basemap in `layout.mapbox.style` uses data from the Mapbox _service_, then you will need to register for a free account at https://mapbox.com/ and obtain a Mapbox Access token. This token should be provided in `layout.mapbox.access_token` (or, if using Plotly Express, via the `px.set_mapbox_access_token()` configuration function).
+The word "mapbox" in the trace names and `layout.mapbox` refers to the Mapbox GL JS open-source library, which is integrated into Plotly.py. If your basemap in `layout.mapbox.style` uses data from the Mapbox _service_, then you will need to register for a free account at https://mapbox.com/ and obtain a Mapbox Access token. This token should be provided in `layout.mapbox.access_token` (or, if using Plotly Express, via the `px.set_mapbox_access_token()` configuration function).
> If your `layout.mapbox.style` does not use data from the Mapbox service, you do _not_ need to register for a Mapbox account.
@@ -192,4 +192,4 @@ See the example in the [plotly and datashader tutorial](/python/datashader).
#### Reference
-See https://plot.ly/python/reference/#layout-mapbox for more information and options!
+See https://plotly.com/python/reference/#layout-mapbox for more information and options!
diff --git a/doc/python/marker-style.md b/doc/python/marker-style.md
index 3b54cc00648..7e67a6f61ab 100644
--- a/doc/python/marker-style.md
+++ b/doc/python/marker-style.md
@@ -342,4 +342,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/mixed-subplots.md b/doc/python/mixed-subplots.md
index 74b73de2386..56299456ffa 100644
--- a/doc/python/mixed-subplots.md
+++ b/doc/python/mixed-subplots.md
@@ -116,4 +116,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/multiple-axes.md b/doc/python/multiple-axes.md
index ff64c197298..8df0465f5a1 100644
--- a/doc/python/multiple-axes.md
+++ b/doc/python/multiple-axes.md
@@ -225,4 +225,4 @@ fig.show()
```
#### Reference
-All of the y-axis properties are found here: https://plot.ly/python/reference/#YAxis. For more information on creating subplots see the [Subplots in Python](/python/subplots/) section.
+All of the y-axis properties are found here: https://plotly.com/python/reference/#YAxis. For more information on creating subplots see the [Subplots in Python](/python/subplots/) section.
diff --git a/doc/python/multiple-transforms.md b/doc/python/multiple-transforms.md
index 0df705417fc..b41f322f2ea 100644
--- a/doc/python/multiple-transforms.md
+++ b/doc/python/multiple-transforms.md
@@ -208,4 +208,4 @@ pio.show(fig_dict, validate=False)
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options!
+See https://plotly.com/python/reference/ for more information and chart attribute options!
diff --git a/doc/python/network-graphs.md b/doc/python/network-graphs.md
index 5a371d7d617..8acf4972249 100644
--- a/doc/python/network-graphs.md
+++ b/doc/python/network-graphs.md
@@ -43,7 +43,7 @@ Install the Python library `networkx` with `pip install networkx`.
-### Create random graph
+### Create random graph
```python
import plotly.graph_objects as go
@@ -134,7 +134,7 @@ fig = go.Figure(data=[edge_trace, node_trace],
hovermode='closest',
margin=dict(b=20,l=5,r=5,t=40),
annotations=[ dict(
- text="Python code: https://plot.ly/ipython-notebooks/network-graphs/",
+ text="Python code: https://plotly.com/ipython-notebooks/network-graphs/",
showarrow=False,
xref="paper", yref="paper",
x=0.005, y=-0.002 ) ],
@@ -146,4 +146,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatter for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatter for more information and chart attribute options!
diff --git a/doc/python/ohlc-charts.md b/doc/python/ohlc-charts.md
index ac49289b396..585688df9ac 100644
--- a/doc/python/ohlc-charts.md
+++ b/doc/python/ohlc-charts.md
@@ -25,7 +25,7 @@ jupyter:
The [OHLC](https://en.wikipedia.org/wiki/Open-high-low-close_chart) chart (for open, high, low and close) is a style of financial chart describing open, high, low and close values for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red.
-See also [Candlestick Charts](https://plot.ly/python/candlestick-charts/) and [other financial charts](https://plot.ly/python/#financial-charts).
+See also [Candlestick Charts](https://plotly.com/python/candlestick-charts/) and [other financial charts](https://plotly.com/python/#financial-charts).
#### Simple OHLC Chart with Pandas
@@ -155,4 +155,4 @@ fig.show()
```
#### Reference
-For more information on candlestick attributes, see: https://plot.ly/python/reference/#ohlc
+For more information on candlestick attributes, see: https://plotly.com/python/reference/#ohlc
diff --git a/doc/python/orca-management.md b/doc/python/orca-management.md
index 2a1533ebff8..0761747ec0b 100644
--- a/doc/python/orca-management.md
+++ b/doc/python/orca-management.md
@@ -164,7 +164,7 @@ Searched for executable 'orca' on the following path:
If you haven't installed orca yet, you can do so using conda as follows:
- $ conda install -c plotly plotly-orca
+ $ conda install -c plotly plotly-orca==1.2.1
Alternatively, see other installation methods in the orca project README at
https://github.com/plotly/orca.
@@ -184,7 +184,7 @@ will be applied automatically in future sessions. You can do this as follows:
>>> plotly.io.orca.config.save()
If you're still having trouble, feel free to ask for help on the forums at
-https://community.plot.ly/c/api/python
+https://community.plotly.com/c/api/python
----------------------------------------------------------------------------
```
If this happens, follow the instructions in the error message and specify the full path to you orca executable using the `plotly.io.orca.config.executable` configuration property.
diff --git a/doc/python/parallel-categories-diagram.md b/doc/python/parallel-categories-diagram.md
index 58ff71bd587..0d13144ffb9 100644
--- a/doc/python/parallel-categories-diagram.md
+++ b/doc/python/parallel-categories-diagram.md
@@ -288,4 +288,4 @@ widgets.VBox([color_toggle, fig])
#### Reference
-See [reference page](https://plot.ly/python/reference/#parcats) for more information and chart attribute options!
+See [reference page](https://plotly.com/python/reference/#parcats) for more information and chart attribute options!
diff --git a/doc/python/parallel-coordinates-plot.md b/doc/python/parallel-coordinates-plot.md
index b33b410ab42..034f372e0fb 100644
--- a/doc/python/parallel-coordinates-plot.md
+++ b/doc/python/parallel-coordinates-plot.md
@@ -173,4 +173,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#parcoords for more information and chart attribute options!
+See https://plotly.com/python/reference/#parcoords for more information and chart attribute options!
diff --git a/doc/python/peak-finding.md b/doc/python/peak-finding.md
index f755b6ff60e..f04375af7ec 100644
--- a/doc/python/peak-finding.md
+++ b/doc/python/peak-finding.md
@@ -36,7 +36,7 @@ jupyter:
#### Imports
-The tutorial below imports [Pandas](https://plot.ly/pandas/intro-to-pandas-tutorial/), and [SciPy](https://www.scipy.org/).
+The tutorial below imports [Pandas](https://plotly.com/pandas/intro-to-pandas-tutorial/), and [SciPy](https://www.scipy.org/).
```python
import pandas as pd
@@ -62,7 +62,7 @@ fig = go.Figure(data=go.Scatter(
fig.show()
```
-#### Peak Detection
+#### Peak Detection
We need to find the x-axis indices for the peaks in order to determine where the peaks are located.
diff --git a/doc/python/pie-charts.md b/doc/python/pie-charts.md
index 38dfd175c68..dce6a8dea13 100644
--- a/doc/python/pie-charts.md
+++ b/doc/python/pie-charts.md
@@ -81,9 +81,9 @@ For more information about discrete colors, see the [dedicated page](/python/dis
import plotly.express as px
df = px.data.tips()
fig = px.pie(df, values='tip', names='day', color='day',
- color_discrete_map={'Thur':'lightcyan',
- 'Fri':'cyan',
- 'Sat':'royalblue',
+ color_discrete_map={'Thur':'lightcyan',
+ 'Fri':'cyan',
+ 'Sat':'royalblue',
'Sun':'darkblue'})
fig.show()
```
@@ -213,7 +213,7 @@ fig.add_trace(go.Pie(labels=labels, values=[16, 15, 12, 6, 5, 4, 42], name="GHG
fig.add_trace(go.Pie(labels=labels, values=[27, 11, 25, 8, 1, 3, 25], name="CO2 Emissions"),
1, 2)
-# Use `hole` to create a donut-like pie chart
+# Use `hole` to create a donut-like pie chart
fig.update_traces(hole=.4, hoverinfo="label+percent+name")
fig.update_layout(
@@ -304,4 +304,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#pie for more information and chart attribute options!
+See https://plotly.com/python/reference/#pie for more information and chart attribute options!
diff --git a/doc/python/plot-data-from-csv.md b/doc/python/plot-data-from-csv.md
index 1efd4fc7d74..6e3c8258764 100644
--- a/doc/python/plot-data-from-csv.md
+++ b/doc/python/plot-data-from-csv.md
@@ -76,4 +76,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/getting-started for more information about Plotly's Python API!
+See https://plotly.com/python/getting-started for more information about Plotly's Python API!
diff --git a/doc/python/plotly-express.md b/doc/python/plotly-express.md
index b5584b757b9..e0396d9c213 100644
--- a/doc/python/plotly-express.md
+++ b/doc/python/plotly-express.md
@@ -41,7 +41,7 @@ Plotly Express is the easy-to-use, high-level interface to Plotly, which [operat
> **Note**: Plotly Express was previously its own separately-installed `plotly_express` package but is now part of `plotly` and importable via `import plotly.express as px`.
-This notebook demonstrates various `plotly.express` features. [Reference documentation](https://plot.ly/python-api-reference/plotly.express.html) is also available, as well as a [tutorial on input argument types](/python/px-arguments) and one on how to [style figures made with Plotly Express](/python/styling-plotly-express/).
+This notebook demonstrates various `plotly.express` features. [Reference documentation](https://plotly.com/python-api-reference/plotly.express.html) is also available, as well as a [tutorial on input argument types](/python/px-arguments) and one on how to [style figures made with Plotly Express](/python/styling-plotly-express/).
You can also read our original [Medium announcement article](https://medium.com/@plotlygraphs/introducing-plotly-express-808df010143d) for more information on this library.
diff --git a/doc/python/polar-chart.md b/doc/python/polar-chart.md
index ce6ac9aee0b..ad8b8671ea5 100644
--- a/doc/python/polar-chart.md
+++ b/doc/python/polar-chart.md
@@ -72,7 +72,7 @@ fig = px.line_polar(df, r="frequency", theta="direction", color="strength", line
fig.show()
```
-See also the [wind rose page](https://plot.ly/python/wind-rose-charts/) for more wind rose visualizations in polar coordinates.
+See also the [wind rose page](https://plotly.com/python/wind-rose-charts/) for more wind rose visualizations in polar coordinates.
You can plot less than a whole circle with the `range_theta` argument, and also control the `start_angle` and `direction`:
@@ -85,7 +85,7 @@ fig.show()
## Polar Scatter Plot with go.Scatterpolar
-If Plotly Express does not provide a good starting point, you can use the more generic `go.Scatterpolar`. All the options are documented in the [reference page](https://plot.ly/python/reference/#scatterpolar).
+If Plotly Express does not provide a good starting point, you can use the more generic `go.Scatterpolar`. All the options are documented in the [reference page](https://plotly.com/python/reference/#scatterpolar).
#### Basic Polar Chart
@@ -257,7 +257,7 @@ fig.update_traces(mode = "lines+markers",
# The sector is [0, 360] by default, we update it for the first plot only
fig.update_layout(
showlegend = False,
- polar = dict(# setting parameters for the second plot would be polar2=dict(...)
+ polar = dict(# setting parameters for the second plot would be polar2=dict(...)
sector = [150,210],
))
@@ -438,4 +438,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatterpolar for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatterpolar for more information and chart attribute options!
diff --git a/doc/python/radar-chart.md b/doc/python/radar-chart.md
index 6ffa8c5fbfb..22e021a2312 100644
--- a/doc/python/radar-chart.md
+++ b/doc/python/radar-chart.md
@@ -129,4 +129,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scatterpolar for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatterpolar for more information and chart attribute options!
diff --git a/doc/python/random-walk.md b/doc/python/random-walk.md
index 11867ddb80e..2434a54228e 100644
--- a/doc/python/random-walk.md
+++ b/doc/python/random-walk.md
@@ -34,7 +34,7 @@ jupyter:
thumbnail: /images/static-image
---
-A [random walk](https://en.wikipedia.org/wiki/Random_walk) can be thought of as a random process in which a token or a marker is randomly moved around some space, that is, a space with a metric used to compute distance. It is more commonly conceptualized in one dimension ($\mathbb{Z}$), two dimensions ($\mathbb{Z}^2$) or three dimensions ($\mathbb{Z}^3$) in Cartesian space, where $\mathbb{Z}$ represents the set of integers. In the visualizations below, we will be using [scatter plots](https://plot.ly/python/line-and-scatter/) as well as a colorscale to denote the time sequence of the walk.
+A [random walk](https://en.wikipedia.org/wiki/Random_walk) can be thought of as a random process in which a token or a marker is randomly moved around some space, that is, a space with a metric used to compute distance. It is more commonly conceptualized in one dimension ($\mathbb{Z}$), two dimensions ($\mathbb{Z}^2$) or three dimensions ($\mathbb{Z}^3$) in Cartesian space, where $\mathbb{Z}$ represents the set of integers. In the visualizations below, we will be using [scatter plots](https://plotly.com/python/line-and-scatter/) as well as a colorscale to denote the time sequence of the walk.
#### Random Walk in 1D
diff --git a/doc/python/range-slider.md b/doc/python/range-slider.md
index 31b7074007f..e3437e16f97 100644
--- a/doc/python/range-slider.md
+++ b/doc/python/range-slider.md
@@ -342,4 +342,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#layout-xaxis-rangeselector
and https://plot.ly/python/reference/#layout-xaxis-rangeslider
for more information and attribute options!
+See https://plotly.com/python/reference/#layout-xaxis-rangeselector
and https://plotly.com/python/reference/#layout-xaxis-rangeslider
for more information and attribute options!
diff --git a/doc/python/renderers.md b/doc/python/renderers.md
index c041fdba9fc..ddd27bd8c11 100644
--- a/doc/python/renderers.md
+++ b/doc/python/renderers.md
@@ -156,7 +156,7 @@ The `plotly_mimetype` renderer creates a specification of the plotly figure (cal
These are aliases for `plotly_mimetype` since this renderer is a good choice when working in JupyterLab, nteract, and the Visual Studio Code notebook interface.
##### Static image renderers
-A set of renderers is provided for displaying figures as static images. These renderers all rely on the orca static image export utility. See the [Static Image Export](https://plot.ly/python/static-image-export/) page for more information on getting set up with orca.
+A set of renderers is provided for displaying figures as static images. These renderers all rely on the orca static image export utility. See the [Static Image Export](https://plotly.com/python/static-image-export/) page for more information on getting set up with orca.
###### `png`, `jpeg`, and `svg`
These renderers display figures as static PNG, JPEG, and SVG images respectively. These renderers are useful for user interfaces that do not support inline HTML output, but do support inline static images. Examples include the [QtConsole](https://qtconsole.readthedocs.io/en/stable/), [Spyder](https://www.spyder-ide.org/), and the PyCharm [notebook interface](https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html).
@@ -224,11 +224,11 @@ fig.show(renderer="png", width=800, height=300)
```
### Displaying figures using Dash
-Dash is a Python framework for building web applications, and it provides built-in support for displaying Plotly figures. See the [Dash User Guide](https://dash.plot.ly/) for more information.
+Dash is a Python framework for building web applications, and it provides built-in support for displaying Plotly figures. See the [Dash User Guide](https://dash.plotly.com/) for more information.
It is important to note that Dash does not use the renderers framework discussed above, so you should not use the `.show` figure method or the `plotly.io.show` function inside Dash applications.
## Displaying figures using ipywidgets
-Plotly figures can be displayed in [ipywidgets](https://ipywidgets.readthedocs.io/en/stable/) contexts using `plotly.graph_objects.FigureWidget` objects. `FigureWidget` is a figure graph object (Just like `plotly.graph_objects.Figure`) so you can add traces to it and update it just like a regular `Figure`. But `FigureWidget` is also an ipywidgets object, which means that you can display it alongside other ipywidgets to build user interfaces right in the notebook. See the [Plotly FigureWidget Overview](https://plot.ly/python/figurewidget/) for more information on integrating plotly figures with ipywidgets.
+Plotly figures can be displayed in [ipywidgets](https://ipywidgets.readthedocs.io/en/stable/) contexts using `plotly.graph_objects.FigureWidget` objects. `FigureWidget` is a figure graph object (Just like `plotly.graph_objects.Figure`) so you can add traces to it and update it just like a regular `Figure`. But `FigureWidget` is also an ipywidgets object, which means that you can display it alongside other ipywidgets to build user interfaces right in the notebook. See the [Plotly FigureWidget Overview](https://plotly.com/python/figurewidget/) for more information on integrating plotly figures with ipywidgets.
It is important to note that `FigureWidget` does not use the renderers framework discussed above, so you should not use the `.show` figure method or the `plotly.io.show` function on `FigureWidget` objects.
diff --git a/doc/python/sankey-diagram.md b/doc/python/sankey-diagram.md
index 85761e7ce85..a0801aa05b2 100644
--- a/doc/python/sankey-diagram.md
+++ b/doc/python/sankey-diagram.md
@@ -39,7 +39,7 @@ A [Sankey diagram](https://en.wikipedia.org/wiki/Sankey_diagram) is a flow diagr
### Basic Sankey Diagram
-Sankey diagrams visualize the contributions to a flow by defining [source](https://plot.ly/python/reference/#sankey-link-source) to represent the source node, [target](https://plot.ly/python/reference/#sankey-link-target) for the target node, [value](https://plot.ly/python/reference/#sankey-link-value) to set the flow volum, and [label](https://plot.ly/python/reference/#sankey-node-label) that shows the node name.
+Sankey diagrams visualize the contributions to a flow by defining [source](https://plotly.com/python/reference/#sankey-link-source) to represent the source node, [target](https://plotly.com/python/reference/#sankey-link-target) for the target node, [value](https://plotly.com/python/reference/#sankey-link-value) to set the flow volum, and [label](https://plotly.com/python/reference/#sankey-node-label) that shows the node name.
```python
import plotly.graph_objects as go
@@ -62,19 +62,27 @@ fig.update_layout(title_text="Basic Sankey Diagram", font_size=10)
fig.show()
```
-### More complex Sankey diagram
+### More complex Sankey diagram with colored links
-```python inputHidden=false outputHidden=false
+```python
import plotly.graph_objects as go
import urllib, json
url = 'https://raw.githubusercontent.com/plotly/plotly.js/master/test/image/mocks/sankey_energy.json'
response = urllib.request.urlopen(url)
data = json.loads(response.read())
+
+# override gray link colors with 'source' colors
+opacity = 0.4
+# change 'magenta' to its 'rgba' value to add opacity
+data['data'][0]['node']['color'] = ['rgba(255,0,255, 0.8)' if color == "magenta" else color for color in data['data'][0]['node']['color']]
+data['data'][0]['link']['color'] = [data['data'][0]['node']['color'][src].replace("0.8", str(opacity))
+ for src in data['data'][0]['link']['source']]
+
fig = go.Figure(data=[go.Sankey(
valueformat = ".0f",
valuesuffix = "TWh",
- # Define nodes
+ # Define nodes
node = dict(
pad = 15,
thickness = 15,
@@ -87,8 +95,9 @@ fig = go.Figure(data=[go.Sankey(
source = data['data'][0]['link']['source'],
target = data['data'][0]['link']['target'],
value = data['data'][0]['link']['value'],
- label = data['data'][0]['link']['label']
- ))])
+ label = data['data'][0]['link']['label'],
+ color = data['data'][0]['link']['color']
+))])
fig.update_layout(title_text="Energy forecast for 2050
Source: Department of Energy & Climate Change, Tom Counsell via Mike Bostock",
font_size=10)
@@ -96,7 +105,7 @@ fig.show()
```
### Style Sankey Diagram
-This example also uses [hovermode](https://plot.ly/python/reference/#layout-hovermode) to enable multiple tooltips.
+This example also uses [hovermode](https://plotly.com/python/reference/#layout-hovermode) to enable multiple tooltips.
```python
import plotly.graph_objects as go
@@ -136,7 +145,7 @@ fig.show()
### Define Node Position
-The following example sets [node.x](https://plot.ly/python/reference/#sankey-node-x) and `node.y` to place nodes in the specified locations, except in the `snap arrangement` (default behaviour when `node.x` and `node.y` are not defined) to avoid overlapping of the nodes, therefore, an automatic snapping of elements will be set to define the padding between nodes via [nodepad](https://plot.ly/python/reference/#sankey-node-pad). The other possible arrangements are: 1) perpendicular 2) freeform 3) fixed
+The following example sets [node.x](https://plotly.com/python/reference/#sankey-node-x) and `node.y` to place nodes in the specified locations, except in the `snap arrangement` (default behaviour when `node.x` and `node.y` are not defined) to avoid overlapping of the nodes, therefore, an automatic snapping of elements will be set to define the padding between nodes via [nodepad](https://plotly.com/python/reference/#sankey-node-pad). The other possible arrangements are: 1) perpendicular 2) freeform 3) fixed
```python
import plotly.graph_objects as go
@@ -147,7 +156,7 @@ fig = go.Figure(go.Sankey(
"label": ["A", "B", "C", "D", "E", "F"],
"x": [0.2, 0.1, 0.5, 0.7, 0.3, 0.5],
"y": [0.7, 0.5, 0.2, 0.4, 0.2, 0.3],
- 'pad':10}, # 10 Pixels
+ 'pad':10}, # 10 Pixels
link = {
"source": [0, 0, 1, 2, 5, 4, 3, 5],
"target": [5, 3, 4, 3, 0, 2, 2, 3],
@@ -158,4 +167,4 @@ fig.show()
### Reference
-See [https://plot.ly/python/reference/#sankey](https://plot.ly/python/reference/#sankey) for more information and options!
+See [https://plotly.com/python/reference/#sankey](https://plotly.com/python/reference/#sankey) for more information and options!
diff --git a/doc/python/scatter-plots-on-maps.md b/doc/python/scatter-plots-on-maps.md
index debe6c4771b..6fa0a7bde1c 100644
--- a/doc/python/scatter-plots-on-maps.md
+++ b/doc/python/scatter-plots-on-maps.md
@@ -215,4 +215,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scattergeo and https://plot.ly/python/reference/#layout-geo for more information and chart attribute options!
+See https://plotly.com/python/reference/#scattergeo and https://plotly.com/python/reference/#layout-geo for more information and chart attribute options!
diff --git a/doc/python/scattermapbox.md b/doc/python/scattermapbox.md
index 40290fe992a..e6eff5d373c 100644
--- a/doc/python/scattermapbox.md
+++ b/doc/python/scattermapbox.md
@@ -196,7 +196,7 @@ fig.show()
### Set Marker Symbols
-You can define a symbol on your map by setting [symbol](https://plot.ly/python/reference/#scattermapbox-marker-symbol) attribute. This attribute only works on Mapbox-provided `style`s:
+You can define a symbol on your map by setting [symbol](https://plotly.com/python/reference/#scattermapbox-marker-symbol) attribute. This attribute only works on Mapbox-provided `style`s:
- basic
- streets
@@ -228,4 +228,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#scattermapbox for more information and options!
+See https://plotly.com/python/reference/#scattermapbox for more information and options!
diff --git a/doc/python/setting-graph-size.md b/doc/python/setting-graph-size.md
index 3c12d1911a2..823bcc106f8 100644
--- a/doc/python/setting-graph-size.md
+++ b/doc/python/setting-graph-size.md
@@ -80,7 +80,7 @@ fig.show()
### Automatically Adjust Margins
-Set [automargin](https://plot.ly/python/reference/#layout-xaxis-automargin) to `True` and Plotly will automatically increase the margin size to prevent ticklabels from being cut off or overlapping with axis titles.
+Set [automargin](https://plotly.com/python/reference/#layout-xaxis-automargin) to `True` and Plotly will automatically increase the margin size to prevent ticklabels from being cut off or overlapping with axis titles.
```python
import plotly.graph_objects as go
@@ -113,4 +113,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#layout for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout for more information and chart attribute options!
diff --git a/doc/python/shapes.md b/doc/python/shapes.md
index 67aed5fe285..2b5301b4865 100644
--- a/doc/python/shapes.md
+++ b/doc/python/shapes.md
@@ -35,7 +35,7 @@ jupyter:
### Filled Area Chart
-There are two ways to draw filled shapes: scatter traces and [layout.shapes](https://plot.ly/python/reference/#layout-shapes-items-shape-type) which is mostly useful for the 2d subplots, and defines the shape type to be drawn, and can be rectangle, circle, line, or path (a custom SVG path). You also can use [scatterpolar](https://plot.ly/python/polar-chart/#categorical-polar-chart), scattergeo, [scattermapbox](https://plot.ly/python/filled-area-on-mapbox/#filled-scattermapbox-trace) to draw filled shapes on any kind of subplots. To set an area to be filled with a solid color, you need to define [Scatter.fill="toself"](https://plot.ly/python/reference/#scatter-fill) that connects the endpoints of the trace into a closed shape. If `mode=line` (default value), then you need to repeat the initial point of a shape at the of the sequence to have a closed shape.
+There are two ways to draw filled shapes: scatter traces and [layout.shapes](https://plotly.com/python/reference/#layout-shapes-items-shape-type) which is mostly useful for the 2d subplots, and defines the shape type to be drawn, and can be rectangle, circle, line, or path (a custom SVG path). You also can use [scatterpolar](https://plotly.com/python/polar-chart/#categorical-polar-chart), scattergeo, [scattermapbox](https://plotly.com/python/filled-area-on-mapbox/#filled-scattermapbox-trace) to draw filled shapes on any kind of subplots. To set an area to be filled with a solid color, you need to define [Scatter.fill="toself"](https://plotly.com/python/reference/#scatter-fill) that connects the endpoints of the trace into a closed shape. If `mode=line` (default value), then you need to repeat the initial point of a shape at the of the sequence to have a closed shape.
```python
import plotly.graph_objects as go
@@ -44,7 +44,7 @@ fig = go.Figure(go.Scatter(x=[0,1,2,0], y=[0,2,0,0], fill="toself"))
fig.show()
```
-You can have more shapes either by adding [more traces](https://plot.ly/python/filled-area-plots/) or interrupting the series with `None`.
+You can have more shapes either by adding [more traces](https://plotly.com/python/filled-area-plots/) or interrupting the series with `None`.
```python
import plotly.graph_objects as go
@@ -717,4 +717,4 @@ fig.show()
```
### Reference
-See https://plot.ly/python/reference/#layout-shapes for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-shapes for more information and chart attribute options!
diff --git a/doc/python/sliders.md b/doc/python/sliders.md
index e6eabb70b2b..814b9e162f0 100644
--- a/doc/python/sliders.md
+++ b/doc/python/sliders.md
@@ -81,4 +81,4 @@ fig.show()
```
#### Reference
-Check out https://plot.ly/python/reference/#layout-updatemenus for more information!
+Check out https://plotly.com/python/reference/#layout-updatemenus for more information!
diff --git a/doc/python/smoothing.md b/doc/python/smoothing.md
index 964b50a8575..a182a025795 100644
--- a/doc/python/smoothing.md
+++ b/doc/python/smoothing.md
@@ -36,7 +36,7 @@ jupyter:
#### Imports
-The tutorial below imports [NumPy](http://www.numpy.org/), [Pandas](https://plot.ly/pandas/intro-to-pandas-tutorial/), [SciPy](https://www.scipy.org/) and [Plotly](https://plot.ly/python/getting-started/).
+The tutorial below imports [NumPy](http://www.numpy.org/), [Pandas](https://plotly.com/pandas/intro-to-pandas-tutorial/), [SciPy](https://www.scipy.org/) and [Plotly](https://plotly.com/python/getting-started/).
```python
import plotly.graph_objects as go
@@ -97,7 +97,7 @@ fig.add_trace(go.Scatter(
x=x,
y=signal.savgol_filter(y,
53, # window size used for filtering
- 3), # order of fitted polynomial
+ 3), # order of fitted polynomial
mode='markers',
marker=dict(
size=6,
diff --git a/doc/python/splom.md b/doc/python/splom.md
index e46d8147d3e..0a35089ac33 100644
--- a/doc/python/splom.md
+++ b/doc/python/splom.md
@@ -82,7 +82,7 @@ fig.show()
### Scatter matrix (splom) with go.Splom
-If Plotly Express does not provide a good starting point, it is possible to use the more generic `go.Splom` function. All its parameters are documented in the reference page https://plot.ly/python/reference/#splom.
+If Plotly Express does not provide a good starting point, it is possible to use the more generic `go.Splom` function. All its parameters are documented in the reference page https://plotly.com/python/reference/#splom.
The Plotly splom trace implementation for the scatterplot matrix does not require to set $x=Xi$ , and $y=Xj$, for each scatter plot. All arrays, $X_1,X_2,…,X_n$ , are passed once, through a list of dicts called dimensions, i.e. each array/variable represents a dimension.
diff --git a/doc/python/static-image-export.md b/doc/python/static-image-export.md
index 387fbdd24d5..1ea419b3d08 100644
--- a/doc/python/static-image-export.md
+++ b/doc/python/static-image-export.md
@@ -47,10 +47,10 @@ Static image generation requires the [orca](https://github.com/plotly/orca) comm
##### conda
Using the [conda](https://conda.io/docs/) package manager, you can install these dependencies in a single command:
```
-$ conda install -c plotly plotly-orca psutil requests
+$ conda install -c plotly plotly-orca==1.2.1 psutil requests
```
-**Note:** Even if you do not want to use conda to manage your Python dependencies, it is still useful as a cross platform tool for managing native libraries and command-line utilities (e.g. git, wget, graphviz, boost, gcc, nodejs, cairo, etc.). For this use-case, start with [Miniconda](https://conda.io/miniconda.html) (~60MB) and tell the installer to add itself to your system `PATH`. Then run `conda install plotly-orca` and the orca executable will be available system wide.
+**Note:** Even if you do not want to use conda to manage your Python dependencies, it is still useful as a cross platform tool for managing native libraries and command-line utilities (e.g. git, wget, graphviz, boost, gcc, nodejs, cairo, etc.). For this use-case, start with [Miniconda](https://conda.io/miniconda.html) (~60MB) and tell the installer to add itself to your system `PATH`. Then run `conda install plotly-orca==1.2.1` and the orca executable will be available system wide.
##### npm + pip
You can use the [npm](https://www.npmjs.com/get-npm) package manager to install `orca` (and its `electron` dependency), and then use pip to install `psutil`:
diff --git a/doc/python/streamtube-plot.md b/doc/python/streamtube-plot.md
index e4a0903b93b..14672ae9f28 100644
--- a/doc/python/streamtube-plot.md
+++ b/doc/python/streamtube-plot.md
@@ -131,5 +131,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#streamtube for more information and chart attribute options!
+See https://plotly.com/python/reference/#streamtube for more information and chart attribute options!
diff --git a/doc/python/subplots.md b/doc/python/subplots.md
index 50cf161d45e..4860ef314f7 100644
--- a/doc/python/subplots.md
+++ b/doc/python/subplots.md
@@ -298,7 +298,7 @@ fig.show()
### Subplots with Shared Colorscale
-To share colorscale information in multiple subplots, you can use [coloraxis](https://plot.ly/javascript/reference/#scatter-marker-line-coloraxis).
+To share colorscale information in multiple subplots, you can use [coloraxis](https://plotly.com/javascript/reference/#scatter-marker-line-coloraxis).
```python
from plotly.subplots import make_subplots
@@ -572,8 +572,8 @@ fig.show()
```
#### Reference
-All of the x-axis properties are found here: https://plot.ly/python/reference/#XAxis
-All of the y-axis properties are found here: https://plot.ly/python/reference/#YAxis
+All of the x-axis properties are found here: https://plotly.com/python/reference/#XAxis
+All of the y-axis properties are found here: https://plotly.com/python/reference/#YAxis
```python
from plotly.subplots import make_subplots
diff --git a/doc/python/sunburst-charts.md b/doc/python/sunburst-charts.md
index 1ee76475475..2a423523d7e 100644
--- a/doc/python/sunburst-charts.md
+++ b/doc/python/sunburst-charts.md
@@ -155,7 +155,7 @@ fig =go.Figure(go.Sunburst(
values=[10, 14, 12, 10, 2, 6, 6, 4, 4],
))
# Update layout for tight margin
-# See https://plot.ly/python/creating-and-updating-figures/
+# See https://plotly.com/python/creating-and-updating-figures/
fig.update_layout(margin = dict(t=0, l=0, r=0, b=0))
fig.show()
@@ -214,7 +214,7 @@ fig.show()
### Large Number of Slices
-This example uses a [plotly grid attribute](https://plot.ly/python/reference/#layout-grid) for the suplots. Reference the row and column destination using the [domain](https://plot.ly/python/reference/#sunburst-domain) attribute.
+This example uses a [plotly grid attribute](https://plotly.com/python/reference/#layout-grid) for the suplots. Reference the row and column destination using the [domain](https://plotly.com/python/reference/#sunburst-domain) attribute.
```python
import plotly.graph_objects as go
@@ -326,7 +326,7 @@ def build_hierarchical_dataframe(df, levels, value_column, color_columns=None):
df_all_trees = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
for i, level in enumerate(levels):
df_tree = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
- dfg = df.groupby(levels[i:]).sum(numerical_only=True)
+ dfg = df.groupby(levels[i:]).sum()
dfg = dfg.reset_index()
df_tree['id'] = dfg[level].copy()
if i < len(levels) - 1:
@@ -380,4 +380,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#sunburst for more information and chart attribute options!
+See https://plotly.com/python/reference/#sunburst for more information and chart attribute options!
diff --git a/doc/python/table-subplots.md b/doc/python/table-subplots.md
index 316fe5c3446..c75ad0c5b13 100644
--- a/doc/python/table-subplots.md
+++ b/doc/python/table-subplots.md
@@ -103,5 +103,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#table for more information regarding chart attributes!
-For examples of Plotly Tables, see: https://plot.ly/python/table/
+See https://plotly.com/python/reference/#table for more information regarding chart attributes!
+For examples of Plotly Tables, see: https://plotly.com/python/table/
diff --git a/doc/python/table.md b/doc/python/table.md
index 2996a581d3f..174ce5b2567 100644
--- a/doc/python/table.md
+++ b/doc/python/table.md
@@ -26,7 +26,7 @@ jupyter:
`go.Table` provides a Table object for detailed data viewing. The data are arranged in
a grid of rows and columns. Most styling can be specified for header, columns, rows or individual cells. Table is using a column-major order, ie. the grid is represented as a vector of column vectors.
-Note that [Dash](https://dash.plot.ly/) provides a different type of [DataTable](https://dash.plot.ly/datatable).
+Note that [Dash](https://dash.plotly.com/) provides a different type of [DataTable](https://dash.plotly.com/datatable).
#### Basic Table
@@ -211,4 +211,4 @@ fig.show()
```
#### Reference
-For more information on tables and table attributes see: https://plot.ly/python/reference/#table.
+For more information on tables and table attributes see: https://plotly.com/python/reference/#table.
diff --git a/doc/python/ternary-contour.md b/doc/python/ternary-contour.md
index 211fc9eb2a0..5ff5fd0f385 100644
--- a/doc/python/ternary-contour.md
+++ b/doc/python/ternary-contour.md
@@ -121,7 +121,7 @@ fig = ff.create_ternary_contour(np.array([Al, Y, Cu]), enthalpy,
fig.show()
```
-#### Interpolation mode
+#### Interpolation mode
Two modes are available in order to interpolate between data points: interpolation in Cartesian space (`interp_mode='cartesian'`) or interpolation using the [isometric log-ratio transformation](https://link.springer.com/article/10.1023/A:1023818214614) (see also [preprint](https://www.researchgate.net/profile/Leon_Parent2/post/What_is_the_best_approach_for_diagnosing_nutrient_disorders_and_formulating_fertilizer_recommendations/attachment/59d62a69c49f478072e9cf3f/AS%3A272541220835360%401441990298625/download/Egozcue+et+al+2003.pdf)), `interp_mode='ilr'`. The `ilr` transformation preserves metrics in the [simplex](https://en.wikipedia.org/wiki/Simplex) but is not defined on its edges.
diff --git a/doc/python/ternary-plots.md b/doc/python/ternary-plots.md
index 195b028b5b1..efd01136dce 100644
--- a/doc/python/ternary-plots.md
+++ b/doc/python/ternary-plots.md
@@ -33,7 +33,35 @@ jupyter:
thumbnail: thumbnail/v4-migration.png
---
-### Basic Ternary Plot with Markers
+## Ternary Plots
+
+A ternary plot depicts the ratios of three variables as positions in an equilateral triangle.
+
+## Ternary scatter plot with Plotly Express
+
+[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
+
+Here we use `px.scatter_ternary` to visualize thre three-way split between the three major candidates in a municipal election.
+
+```python
+import plotly.express as px
+df = px.data.election()
+fig = px.scatter_ternary(df, a="Joly", b="Coderre", c="Bergeron")
+fig.show()
+```
+
+We can scale and color the markers to produce a ternary bubble chart.
+
+```python
+import plotly.express as px
+df = px.data.election()
+fig = px.scatter_ternary(df, a="Joly", b="Coderre", c="Bergeron", hover_name="district",
+ color="winner", size="total", size_max=15,
+ color_discrete_map = {"Joly": "blue", "Bergeron": "green", "Coderre":"red"} )
+fig.show()
+```
+
+### Ternary scatter plot with Plotly Graph Objects
```python
import plotly.graph_objects as go
@@ -98,4 +126,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#scatterternary for more information and chart attribute options!
+See https://plotly.com/python/reference/#scatterternary for more information and chart attribute options!
diff --git a/doc/python/text-and-annotations.md b/doc/python/text-and-annotations.md
index d56abb8994e..4e9d4d9a65e 100644
--- a/doc/python/text-and-annotations.md
+++ b/doc/python/text-and-annotations.md
@@ -536,9 +536,9 @@ fig.show()
### Customize Displayed Text with a Text Template
-To show an arbitrary text in your chart you can use [texttemplate](https://plot.ly/python/reference/#pie-texttemplate), which is a template string used for rendering the information, and will override [textinfo](https://plot.ly/python/reference/#treemap-textinfo).
-This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-fomrat's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format).
-`texttemplate` customizes the text that appears on your plot vs. [hovertemplate](https://plot.ly/python/reference/#pie-hovertemplate) that customizes the tooltip text.
+To show an arbitrary text in your chart you can use [texttemplate](https://plotly.com/python/reference/#pie-texttemplate), which is a template string used for rendering the information, and will override [textinfo](https://plotly.com/python/reference/#treemap-textinfo).
+This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format).
+`texttemplate` customizes the text that appears on your plot vs. [hovertemplate](https://plotly.com/python/reference/#pie-hovertemplate) that customizes the tooltip text.
```python
import plotly.graph_objects as go
@@ -554,7 +554,7 @@ fig.show()
### Customize Text Template
-The following example uses [textfont](https://plot.ly/python/reference/#scatterternary-textfont) to customize the added text.
+The following example uses [textfont](https://plotly.com/python/reference/#scatterternary-textfont) to customize the added text.
```python
import plotly.graph_objects as go
@@ -575,8 +575,8 @@ fig.show()
### Set Date in Text Template
-The following example shows how to show date by setting [axis.type](https://plot.ly/python/reference/#layout-yaxis-type) in [funnel charts](https://plot.ly/python/funnel-charts/).
-As you can see [textinfo](https://plot.ly/python/reference/#funnel-textinfo) and [texttemplate](https://plot.ly/python/reference/#funnel-texttemplate) have the same functionality when you want to determine 'just' the trace information on the graph.
+The following example shows how to show date by setting [axis.type](https://plotly.com/python/reference/#layout-yaxis-type) in [funnel charts](https://plotly.com/python/funnel-charts/).
+As you can see [textinfo](https://plotly.com/python/reference/#funnel-textinfo) and [texttemplate](https://plotly.com/python/reference/#funnel-texttemplate) have the same functionality when you want to determine 'just' the trace information on the graph.
```python
from plotly import graph_objects as go
@@ -606,4 +606,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#layout-annotations for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-annotations for more information and chart attribute options!
diff --git a/doc/python/tick-formatting.md b/doc/python/tick-formatting.md
index bd9d0221c5d..8321f3290d1 100644
--- a/doc/python/tick-formatting.md
+++ b/doc/python/tick-formatting.md
@@ -194,5 +194,5 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#layout-xaxis for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-xaxis for more information and chart attribute options!
diff --git a/doc/python/time-series.md b/doc/python/time-series.md
index 0e7d34c50c0..feb2b71a91b 100644
--- a/doc/python/time-series.md
+++ b/doc/python/time-series.md
@@ -35,12 +35,12 @@ jupyter:
### Time Series Plot with `datetime` Objects ###
-Time series can be represented using either `plotly.express` functions (`px.line`, `px.scatter`) or `plotly.graph_objects` charts objects (`go.Scatter`). For more examples of such charts, see the documentation of [line and scatter plots](https://plot.ly/python/line-and-scatter/).
+Time series can be represented using either `plotly.express` functions (`px.line`, `px.scatter`) or `plotly.graph_objects` charts objects (`go.Scatter`). For more examples of such charts, see the documentation of [line and scatter plots](https://plotly.com/python/line-and-scatter/).
Plotly auto-sets the axis type to a date format when the corresponding data are either ISO-formatted date strings or if they're a [date pandas column](https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html) or [datetime NumPy array](https://docs.scipy.org/doc/numpy/reference/arrays.datetime.html).
```python
-# Using plotly.express
+# Using plotly.express
import plotly.express as px
import pandas as pd
@@ -51,7 +51,7 @@ fig.show()
```
```python
-# Using graph_objects
+# Using graph_objects
import plotly.graph_objects as go
import pandas as pd
@@ -101,7 +101,7 @@ fig.add_trace(go.Scatter(
line_color='dimgray',
opacity=0.8))
-# Use date string to set xaxis range
+# Use date string to set xaxis range
fig.update_layout(xaxis_range=['2016-07-01','2016-12-31'],
title_text="Manually Set Date Range")
fig.show()
@@ -128,4 +128,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#layout-xaxis-rangeslider and
https://plot.ly/python/reference/#layout-xaxis-rangeselector for more information and chart attribute options!
+See https://plotly.com/python/reference/#layout-xaxis-rangeslider and
https://plotly.com/python/reference/#layout-xaxis-rangeselector for more information and chart attribute options!
diff --git a/doc/python/tree-plots.md b/doc/python/tree-plots.md
index 26fe30e8ebd..7f834e31d04 100644
--- a/doc/python/tree-plots.md
+++ b/doc/python/tree-plots.md
@@ -137,4 +137,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/ for more information and chart attribute options and http://igraph.org/python/ for more information about the igraph package!
+See https://plotly.com/python/reference/ for more information and chart attribute options and http://igraph.org/python/ for more information about the igraph package!
diff --git a/doc/python/treemaps.md b/doc/python/treemaps.md
index 5f9c9156943..2d73b895bbb 100644
--- a/doc/python/treemaps.md
+++ b/doc/python/treemaps.md
@@ -33,7 +33,7 @@ jupyter:
thumbnail: thumbnail/treemap.png
---
-[Treemap charts](https://en.wikipedia.org/wiki/Treemapping) visualize hierarchical data using nested rectangles. Same as [Sunburst](https://plot.ly/python/sunburst-charts/) the hierarchy is defined by [labels](https://plot.ly/python/reference/#treemap-labels) (`names` for `px.treemap`) and [parents](https://plot.ly/python/reference/#treemap-parents) attributes. Click on one sector to zoom in/out, which also displays a pathbar in the upper-left corner of your treemap. To zoom out you can use the path bar as well.
+[Treemap charts](https://en.wikipedia.org/wiki/Treemapping) visualize hierarchical data using nested rectangles. Same as [Sunburst](https://plotly.com/python/sunburst-charts/) the hierarchy is defined by [labels](https://plotly.com/python/reference/#treemap-labels) (`names` for `px.treemap`) and [parents](https://plotly.com/python/reference/#treemap-parents) attributes. Click on one sector to zoom in/out, which also displays a pathbar in the upper-left corner of your treemap. To zoom out you can use the path bar as well.
### Basic Treemap with plotly.express
@@ -154,10 +154,10 @@ fig.show()
This example uses the following attributes:
-1. [values](https://plot.ly/python/reference/#treemap-values): sets the values associated with each of the sectors.
-2. [textinfo](https://plot.ly/python/reference/#treemap-textinfo): determines which trace information appear on the graph that can be 'text', 'value', 'current path', 'percent root', 'percent entry', and 'percent parent', or any combination of them.
-3. [pathbar](https://plot.ly/python/reference/#treemap-pathbar): a main extra feature of treemap to display the current path of the visible portion of the hierarchical map. It may also be useful for zooming out of the graph.
-4. [branchvalues](https://plot.ly/python/reference/#treemap-branchvalues): determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. In the example below Eva = 65, which is equal to 14 + 12 + 10 + 2 + 6 + 6 + 1 + 4.
+1. [values](https://plotly.com/python/reference/#treemap-values): sets the values associated with each of the sectors.
+2. [textinfo](https://plotly.com/python/reference/#treemap-textinfo): determines which trace information appear on the graph that can be 'text', 'value', 'current path', 'percent root', 'percent entry', and 'percent parent', or any combination of them.
+3. [pathbar](https://plotly.com/python/reference/#treemap-pathbar): a main extra feature of treemap to display the current path of the visible portion of the hierarchical map. It may also be useful for zooming out of the graph.
+4. [branchvalues](https://plotly.com/python/reference/#treemap-branchvalues): determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. In the example below Eva = 65, which is equal to 14 + 12 + 10 + 2 + 6 + 6 + 1 + 4.
When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.
```python
@@ -200,7 +200,7 @@ fig.show()
There are three different ways to change the color of the sectors in Treemap:
-1. [marker.colors](https://plot.ly/python/reference/#treemap-marker-colors), 2) [colorway](https://plot.ly/python/reference/#treemap-colorway), 3) [colorscale](https://plot.ly/python/reference/#treemap-colorscale). The following examples show how to use each of them.
+1. [marker.colors](https://plotly.com/python/reference/#treemap-marker-colors), 2) [colorway](https://plotly.com/python/reference/#treemap-colorway), 3) [colorscale](https://plotly.com/python/reference/#treemap-colorscale). The following examples show how to use each of them.
```python
import plotly.graph_objects as go
@@ -278,7 +278,7 @@ def build_hierarchical_dataframe(df, levels, value_column, color_columns=None):
df_all_trees = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
for i, level in enumerate(levels):
df_tree = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
- dfg = df.groupby(levels[i:]).sum(numerical_only=True)
+ dfg = df.groupby(levels[i:]).sum()
dfg = dfg.reset_index()
df_tree['id'] = dfg[level].copy()
if i < len(levels) - 1:
@@ -332,7 +332,7 @@ fig.show()
### Nested Layers in Treemap
-The following example uses hierarchical data that includes layers and grouping. Treemap and [Sunburst](https://plot.ly/python/sunburst-charts/) charts reveal insights into the data, and the format of your hierarchical data. [maxdepth](https://plot.ly/python/reference/#treemap-maxdepth) attribute sets the number of rendered sectors from the given level.
+The following example uses hierarchical data that includes layers and grouping. Treemap and [Sunburst](https://plotly.com/python/sunburst-charts/) charts reveal insights into the data, and the format of your hierarchical data. [maxdepth](https://plotly.com/python/reference/#treemap-maxdepth) attribute sets the number of rendered sectors from the given level.
```python
import plotly.graph_objects as go
@@ -391,4 +391,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#treemap for more information and chart attribute options!
+See https://plotly.com/python/reference/#treemap for more information and chart attribute options!
diff --git a/doc/python/troubleshooting.md b/doc/python/troubleshooting.md
index 7598a60c357..5435312a7c5 100644
--- a/doc/python/troubleshooting.md
+++ b/doc/python/troubleshooting.md
@@ -37,7 +37,7 @@ jupyter:
### Version Problems
-In order to follow the examples in this documentation, you should have the latest version of `plotly` installed (4.x), as detailed in the [Getting Started](/python/getting-started) guide. This documentation (under https://plot.ly/python) is incompatible with `plotly` version 3.x, for which the documentation is available under https://plot.ly/python/v3.
+In order to follow the examples in this documentation, you should have the latest version of `plotly` installed (4.x), as detailed in the [Getting Started](/python/getting-started) guide. This documentation (under https://plotly.com/python) is incompatible with `plotly` version 3.x, for which the documentation is available under https://plotly.com/python/v3.
### Import Problems
diff --git a/doc/python/v4-migration.md b/doc/python/v4-migration.md
index 052671fac73..9a3ad776557 100644
--- a/doc/python/v4-migration.md
+++ b/doc/python/v4-migration.md
@@ -39,7 +39,7 @@ Upgrading to version 4 of `plotly` is a matter of following the instructions in
### Getting Help
-If you encounter issues in upgrading from version 3 to version 4, please reach out in our [Community Forum](https://community.plot.ly/c/api/python) or if you've found an issue or regression in version 4, please report a [Github Issue](https://github.com/plotly/plotly.py/issues/new)
+If you encounter issues in upgrading from version 3 to version 4, please reach out in our [Community Forum](https://community.plotly.com/c/api/python) or if you've found an issue or regression in version 4, please report a [Github Issue](https://github.com/plotly/plotly.py/issues/new)
### Online features (`plotly.plotly`) moved to `chart-studio` package
diff --git a/doc/python/violin.md b/doc/python/violin.md
index 149f7f49c9c..7f6be074e98 100644
--- a/doc/python/violin.md
+++ b/doc/python/violin.md
@@ -34,11 +34,11 @@ jupyter:
thumbnail: thumbnail/violin.jpg
---
-## Violin Plot with Plotly Express
+## Violin Plot with Plotly Express
-A [violin plot](https://en.wikipedia.org/wiki/Violin_plot) is a statistical representation of numerical data. It is similar to a [box plot](https://plot.ly/python/box-plots/), with the addition of a rotated [kernel density](https://en.wikipedia.org/wiki/Kernel_density_estimation) plot on each side.
+A [violin plot](https://en.wikipedia.org/wiki/Violin_plot) is a statistical representation of numerical data. It is similar to a [box plot](https://plotly.com/python/box-plots/), with the addition of a rotated [kernel density](https://en.wikipedia.org/wiki/Kernel_density_estimation) plot on each side.
-See also the [list of other statistical charts](https://plot.ly/python/statistical-charts/).
+See also the [list of other statistical charts](https://plotly.com/python/statistical-charts/).
### Basic Violin Plot with Plotly Express
@@ -88,7 +88,7 @@ fig.show()
## Violin Plot with go.Violin
-If Plotly Express does not provide a good starting point, you can use the more generic function `go.Violin` from `plotly.graph_objects`. All the options of `go.Violin` are documented in the reference https://plot.ly/python/reference/#violin
+If Plotly Express does not provide a good starting point, you can use the more generic function `go.Violin` from `plotly.graph_objects`. All the options of `go.Violin` are documented in the reference https://plotly.com/python/reference/#violin
#### Basic Violin Plot
@@ -233,7 +233,7 @@ fig.update_layout(
fig.show()
```
-#### Ridgeline plot
+#### Ridgeline plot
A ridgeline plot ([previously known as Joy Plot](https://serialmentor.com/blog/2017/9/15/goodbye-joyplots)) shows the distribution of a numerical value for several groups. They can be used for visualizing changes in distributions over time or space.
@@ -260,4 +260,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#violin for more information and chart attribute options!
+See https://plotly.com/python/reference/#violin for more information and chart attribute options!
diff --git a/doc/python/visualizing-mri-volume-slices.md b/doc/python/visualizing-mri-volume-slices.md
index 846fc3e93ff..63bf99e0627 100644
--- a/doc/python/visualizing-mri-volume-slices.md
+++ b/doc/python/visualizing-mri-volume-slices.md
@@ -140,5 +140,5 @@ Here's where you can find her:
#### Reference
-For additional information and help setting up a slider in an animation, see https://plot.ly/python/gapminder-example/. For more documentation on creating animations with Plotly, see https://plot.ly/python/#animations.
+For additional information and help setting up a slider in an animation, see https://plotly.com/python/gapminder-example/. For more documentation on creating animations with Plotly, see https://plotly.com/python/#animations.
diff --git a/doc/python/waterfall-charts.md b/doc/python/waterfall-charts.md
index 70236cfe1e7..cee1f3dcef8 100644
--- a/doc/python/waterfall-charts.md
+++ b/doc/python/waterfall-charts.md
@@ -57,7 +57,7 @@ fig.show()
```
### Multi Category Waterfall Chart
-This example uses the [waterfallgroupgap attribute](https://plot.ly/python/reference/#layout-waterfallgroupgap), which sets a gap between bars.
+This example uses the [waterfallgroupgap attribute](https://plotly.com/python/reference/#layout-waterfallgroupgap), which sets a gap between bars.
```python
import plotly.graph_objects as go
@@ -88,7 +88,7 @@ fig.show()
```
### Setting Marker Size and Color
-This example uses [decreasing, increasing, and total](https://plot.ly/python/reference/#waterfall-increasing) attributes to customize the bars.
+This example uses [decreasing, increasing, and total](https://plotly.com/python/reference/#waterfall-increasing) attributes to customize the bars.
```python
import plotly.graph_objects as go
@@ -129,4 +129,4 @@ fig.show()
```
#### Reference
-See https://plot.ly/python/reference/#waterfall for more information and chart attribute options!
+See https://plotly.com/python/reference/#waterfall for more information and chart attribute options!
diff --git a/doc/python/webgl-vs-svg.md b/doc/python/webgl-vs-svg.md
index ff11ace247f..9885259874a 100644
--- a/doc/python/webgl-vs-svg.md
+++ b/doc/python/webgl-vs-svg.md
@@ -38,7 +38,7 @@ For larger datasets, or for a clearer visualization of the density of points,
it is also possible to use [datashader](/python/datashader/).
#### Compare WebGL and SVG
-Checkout [this notebook](https://plot.ly/python/compare-webgl-svg) to compare WebGL and SVG scatter plots with 75,000 random data points
+Checkout [this notebook](https://plotly.com/python/compare-webgl-svg) to compare WebGL and SVG scatter plots with 75,000 random data points
#### WebGL with Plotly Express
@@ -149,4 +149,4 @@ fig.show()
### Reference
-See https://plot.ly/python/reference/#scattergl for more information and chart attribute options!
+See https://plotly.com/python/reference/#scattergl for more information and chart attribute options!
diff --git a/doc/python/wind-rose-charts.md b/doc/python/wind-rose-charts.md
index f2596fa4120..1ed4fda77b3 100644
--- a/doc/python/wind-rose-charts.md
+++ b/doc/python/wind-rose-charts.md
@@ -92,4 +92,4 @@ fig.show()
#### Reference
-See https://plot.ly/python/reference/#barpolar for more information and chart attribute options!
+See https://plotly.com/python/reference/#barpolar for more information and chart attribute options!
diff --git a/doc/requirements.txt b/doc/requirements.txt
index d3c31a85b65..0df715ec0a0 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,4 +1,4 @@
-plotly==4.5.1
+plotly==4.5.4
jupytext==1.1.1
jupyter
notebook
@@ -24,3 +24,4 @@ pathlib
python-frontmatter
datashader
pyarrow
+cufflinks==0.17.3
diff --git a/doc/what_about_dash.md b/doc/what_about_dash.md
new file mode 100644
index 00000000000..e1cc88a4e1c
--- /dev/null
+++ b/doc/what_about_dash.md
@@ -0,0 +1,28 @@
+
+
+### What About Dash?
+
+[Dash](https://dash.plot.ly/) is an open-source framework for building analytical applications, with no Javascript required, and it is tightly integrated with the Plotly graphing library.
+
+Learn about how to install Dash at https://dash.plot.ly/installation.
+
+Everywhere in this page that you see `fig.show()`, you can display the same figure in a Dash application by passing it to the `figure` argument of the [`Graph` component](https://dash.plot.ly/dash-core-components/graph) from the built-in `dash_core_components` package like this:
+
+```python
+import plotly.graph_objects as go # or plotly.express as px
+fig = go.Figure() # or any Plotly Express function e.g. px.bar(...)
+# fig.add_trace( ... )
+# fig.update_layout( ... )
+
+import dash
+import dash_core_components as dcc
+import dash_html_components as html
+
+app = dash.Dash()
+app.layout = html.Div([
+ dcc.Graph(figure=fig)
+])
+
+app.run_server(debug=True, use_reloader=False) # Turn off reloader if inside Jupyter
+```
+
diff --git a/packages/javascript/jupyterlab-plotly/package-lock.json b/packages/javascript/jupyterlab-plotly/package-lock.json
index 8a2339f6f69..17cdaf3edc1 100644
--- a/packages/javascript/jupyterlab-plotly/package-lock.json
+++ b/packages/javascript/jupyterlab-plotly/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "jupyterlab-plotly",
- "version": "1.5.3",
+ "version": "1.5.4",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/packages/javascript/jupyterlab-plotly/package.json b/packages/javascript/jupyterlab-plotly/package.json
index 3fa2beecdc5..b8980557dcf 100644
--- a/packages/javascript/jupyterlab-plotly/package.json
+++ b/packages/javascript/jupyterlab-plotly/package.json
@@ -1,6 +1,6 @@
{
"name": "jupyterlab-plotly",
- "version": "1.5.3",
+ "version": "1.5.4",
"description": "The plotly JupyterLab extension",
"author": "The plotly.py team",
"license": "MIT",
diff --git a/packages/javascript/plotlywidget/package-lock.json b/packages/javascript/plotlywidget/package-lock.json
index 6273fc79f85..f08778735f1 100644
--- a/packages/javascript/plotlywidget/package-lock.json
+++ b/packages/javascript/plotlywidget/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "plotlywidget",
- "version": "1.5.3",
+ "version": "1.5.4",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/packages/javascript/plotlywidget/package.json b/packages/javascript/plotlywidget/package.json
index 7bd03cf5c71..c919932867b 100644
--- a/packages/javascript/plotlywidget/package.json
+++ b/packages/javascript/plotlywidget/package.json
@@ -1,6 +1,6 @@
{
"name": "plotlywidget",
- "version": "1.5.3",
+ "version": "1.5.4",
"description": "The plotly JupyterLab extension",
"author": "The plotly.py team",
"license": "MIT",
@@ -34,7 +34,7 @@
},
"dependencies": {
"plotly.js": "^1.52.2",
- "@jupyter-widgets/base": "^2.0.0",
+ "@jupyter-widgets/base": "^2.0.0 || ^3.0.0",
"lodash": "^4.17.4"
},
"jupyterlab": {
diff --git a/packages/python/chart-studio/chart_studio/exceptions.py b/packages/python/chart-studio/chart_studio/exceptions.py
index b63a7057258..675edff9103 100644
--- a/packages/python/chart-studio/chart_studio/exceptions.py
+++ b/packages/python/chart-studio/chart_studio/exceptions.py
@@ -37,7 +37,7 @@ def __str__(self):
"column to Plotly before you can assign it to '{reference}'.\n"
"To upload, try `plotly.plotly.grid_objs.upload` or "
"`plotly.plotly.grid_objs.append_column`.\n"
- "Questions? chris@plot.ly"
+ "Questions? chris@plotly.com"
)
NON_UNIQUE_COLUMN_MESSAGE = (
@@ -65,7 +65,7 @@ def __init__(self):
">>> import plotly.tools as tls\n"
">>> tls.set_credentials_file(username='username', "
"api_key='api-key')\n\n"
- "For more help, see https://plot.ly/python.\n"
+ "For more help, see https://plotly.com/python.\n"
)
super(PlotlyLocalCredentialsError, self).__init__(message)
diff --git a/packages/python/chart-studio/chart_studio/files.py b/packages/python/chart-studio/chart_studio/files.py
index ca04978d080..453c18b6f8c 100644
--- a/packages/python/chart-studio/chart_studio/files.py
+++ b/packages/python/chart-studio/chart_studio/files.py
@@ -18,9 +18,9 @@
"stream_ids": [],
},
CONFIG_FILE: {
- "plotly_domain": "https://plot.ly",
- "plotly_streaming_domain": "stream.plot.ly",
- "plotly_api_domain": "https://api.plot.ly",
+ "plotly_domain": "https://plotly.com",
+ "plotly_streaming_domain": "stream.plotly.com",
+ "plotly_api_domain": "https://api.plotly.com",
"plotly_ssl_verification": True,
"plotly_proxy_authorization": False,
"world_readable": True,
diff --git a/packages/python/chart-studio/chart_studio/plotly/plotly.py b/packages/python/chart-studio/chart_studio/plotly/plotly.py
index 2df1bb5ad0a..07e8d2e1f0d 100644
--- a/packages/python/chart-studio/chart_studio/plotly/plotly.py
+++ b/packages/python/chart-studio/chart_studio/plotly/plotly.py
@@ -448,7 +448,7 @@ def get_figure(file_owner_or_url, file_id=None, raw=False):
pass a valid plotly url as the first argument.
Examples:
- fig = get_figure('https://plot.ly/~chris/1638')
+ fig = get_figure('https://plotly.com/~chris/1638')
fig = get_figure('chris', 1638)
Note, if you're using a file_owner string as the first argument, you MUST
@@ -574,7 +574,7 @@ class Stream:
Every viewer of the graph sees the same data at the same time.
View examples and tutorials here:
- https://plot.ly/python/streaming/
+ https://plotly.com/python/streaming/
Stream example:
# Initialize a streaming graph
@@ -602,7 +602,7 @@ def __init__(self, stream_id):
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
- https://plot.ly/python/streaming/
+ https://plotly.com/python/streaming/
"""
self.stream_id = stream_id
@@ -664,7 +664,7 @@ def open(self):
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
- https://plot.ly/python/streaming/
+ https://plotly.com/python/streaming/
"""
streaming_specs = self.get_streaming_specs()
@@ -746,7 +746,7 @@ def close(self):
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
- https://plot.ly/python/streaming/
+ https://plotly.com/python/streaming/
"""
try:
@@ -771,7 +771,7 @@ def get(figure_or_data, format="png", width=None, height=None, scale=None):
- figure_or_data: The figure dict-like or data list-like object that
describes a plotly figure.
Same argument used in `py.plot`, `py.iplot`,
- see https://plot.ly/python for examples
+ see https://plotly.com/python for examples
- format: 'png', 'svg', 'jpeg', 'pdf', 'emf'
- width: output width
- height: output height
@@ -798,7 +798,7 @@ def get(figure_or_data, format="png", width=None, height=None, scale=None):
"package currently only supports png, svg, jpeg, and pdf. "
"Learn more about image exporting, and the currently "
"supported file types here: "
- "https://plot.ly/python/static-image-export/"
+ "https://plotly.com/python/static-image-export/"
)
if scale is not None:
try:
@@ -839,7 +839,7 @@ def ishow(cls, figure_or_data, format="png", width=None, height=None, scale=None
- figure_or_data: The figure dict-like or data list-like object that
describes a plotly figure.
Same argument used in `py.plot`, `py.iplot`,
- see https://plot.ly/python for examples
+ see https://plotly.com/python for examples
- format: 'png', 'svg', 'jpeg', 'pdf'
- width: output width
- height: output height
@@ -883,7 +883,7 @@ def save_as(
- figure_or_data: The figure dict-like or data list-like object that
describes a plotly figure.
Same argument used in `py.plot`, `py.iplot`,
- see https://plot.ly/python for examples
+ see https://plotly.com/python for examples
- filename: The filepath to save the image to
- format: 'png', 'svg', 'jpeg', 'pdf', 'emf'
- width: output width
@@ -1135,7 +1135,7 @@ def append_columns(cls, columns, grid=None, grid_url=None):
from plotly.grid_objs import Grid, Column
import plotly.plotly as py
- grid_url = 'https://plot.ly/~chris/3143'
+ grid_url = 'https://plotly.com/~chris/3143'
column_1 = Column([1, 2, 3], 'time')
py.grid_ops.append_columns([column_1], grid_url=grid_url)
```
@@ -1204,7 +1204,7 @@ def append_rows(cls, rows, grid=None, grid_url=None):
from plotly.grid_objs import Grid
import plotly.plotly as py
- grid_url = 'https://plot.ly/~chris/3143'
+ grid_url = 'https://plotly.com/~chris/3143'
row = [1, 5]
py.grid_ops.append_rows([row], grid=grid_url)
@@ -1276,7 +1276,7 @@ def delete(cls, grid=None, grid_url=None):
```
import plotly.plotly as py
- grid_url = 'https://plot.ly/~chris/3'
+ grid_url = 'https://plotly.com/~chris/3'
py.grid_ops.delete(grid_url=grid_url)
```
@@ -1334,7 +1334,7 @@ def upload(cls, meta, grid=None, grid_url=None):
```
import plotly.plotly as py
- grid_url = 'https://plot.ly/~chris/3143'
+ grid_url = 'https://plotly.com/~chris/3143'
meta = {'experment': 'GaAs'}
@@ -1371,7 +1371,7 @@ def parse_grid_id_args(grid, grid_url):
"grid: a plotly.graph_objs.Grid object that has already\n"
" been uploaded to Plotly.\n\n"
"grid_url: the url where the grid can be accessed on\n"
- " Plotly, e.g. 'https://plot.ly/~chris/3043'\n\n"
+ " Plotly, e.g. 'https://plotly.com/~chris/3043'\n\n"
)
elif len(supplied_arg_names) > 1:
raise exceptions.InputError(
diff --git a/packages/python/chart-studio/chart_studio/presentation_objs/presentation_objs.py b/packages/python/chart-studio/chart_studio/presentation_objs/presentation_objs.py
index eee6616e088..d96599110f2 100644
--- a/packages/python/chart-studio/chart_studio/presentation_objs/presentation_objs.py
+++ b/packages/python/chart-studio/chart_studio/presentation_objs/presentation_objs.py
@@ -939,7 +939,7 @@ class Presentation(dict):
Default = True.
For examples see the documentation:\n
- https://plot.ly/python/presentations-api/
+ https://plotly.com/python/presentations-api/
"""
def __init__(self, markdown_string=None, style="moods", imgStretch=True):
diff --git a/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_file_tools.py b/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_file_tools.py
index 81b66f6e9b8..db994d931c3 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_file_tools.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_file_tools.py
@@ -80,8 +80,8 @@ def test_reset_config_file(self):
tools.reset_config_file()
config = tools.get_config_file()
- self.assertEqual(config["plotly_domain"], "https://plot.ly")
- self.assertEqual(config["plotly_streaming_domain"], "stream.plot.ly")
+ self.assertEqual(config["plotly_domain"], "https://plotly.com")
+ self.assertEqual(config["plotly_streaming_domain"], "stream.plotly.com")
def test_get_credentials_file(self):
diff --git a/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_get_embed.py b/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_get_embed.py
index 77709176e50..6aedf87bb62 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_get_embed.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_core/test_tools/test_get_embed.py
@@ -9,12 +9,12 @@
def test_get_valid_embed():
- url = "https://plot.ly/~PlotBot/82/"
+ url = "https://plotly.com/~PlotBot/82/"
tls.get_embed(url)
def test_get_invalid_embed():
- url = "https://plot.ly/~PlotBot/a/"
+ url = "https://plotly.com/~PlotBot/a/"
with pytest.raises(PlotlyError):
tls.get_embed(url)
@@ -25,7 +25,7 @@ def test_get_embed_url_with_share_key(self):
# Check the embed url for url with share_key included
get_embed_return = tls.get_embed(
- "https://plot.ly/~neda/6572" + "?share_key=AH4MyPlyDyDWYA2cM2kj2m"
+ "https://plotly.com/~neda/6572" + "?share_key=AH4MyPlyDyDWYA2cM2kj2m"
)
expected_get_embed = (
'"
).format(
- plotly_rest_url="https://" + "plot.ly",
+ plotly_rest_url="https://" + "plotly.com",
file_owner="neda",
file_id="6572",
share_key="AH4MyPlyDyDWYA2" + "cM2kj2m",
diff --git a/packages/python/chart-studio/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py b/packages/python/chart-studio/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py
index a4b2bf52a5a..8ca36145216 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py
@@ -23,7 +23,7 @@
@pytest.mark.matplotlib
class PlotMPLTest(TestCase):
def setUp(self):
- py.sign_in("PlotlyImageTest", "786r5mecv0", plotly_domain="https://plot.ly")
+ py.sign_in("PlotlyImageTest", "786r5mecv0", plotly_domain="https://plotly.com")
def test_update_type_error(self):
fig, ax = plt.subplots()
@@ -45,7 +45,7 @@ def test_update(self):
title = "new title"
update = {"layout": {"title": title}}
url = py.plot_mpl(fig, update=update, filename="nosetests", auto_open=False)
- un = url.replace("https://plot.ly/~", "").split("/")[0]
- fid = url.replace("https://plot.ly/~", "").split("/")[1]
+ un = url.replace("https://plotly.com/~", "").split("/")[0]
+ fid = url.replace("https://plotly.com/~", "").split("/")[1]
pfig = py.get_figure(un, fid)
assert pfig["layout"]["title"]["text"] == title
diff --git a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py
index b0c4ca68ba2..429315c1d91 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py
@@ -47,14 +47,14 @@ def test_get_figure(self):
def test_get_figure_with_url(self):
un = "PlotlyImageTest"
ak = "786r5mecv0"
- url = "https://plot.ly/~PlotlyImageTest/13183/"
+ url = "https://plotly.com/~PlotlyImageTest/13183/"
py.sign_in(un, ak)
py.get_figure(url)
def test_get_figure_invalid_1(self):
un = "PlotlyImageTest"
ak = "786r5mecv0"
- url = "https://plot.ly/~PlotlyImageTest/a/"
+ url = "https://plotly.com/~PlotlyImageTest/a/"
py.sign_in(un, ak)
with self.assertRaises(exceptions.PlotlyError):
py.get_figure(url)
@@ -62,7 +62,7 @@ def test_get_figure_invalid_1(self):
def test_get_figure_invalid_2(self):
un = "PlotlyImageTest"
ak = "786r5mecv0"
- url = "https://plot.ly/~PlotlyImageTest/-1/"
+ url = "https://plotly.com/~PlotlyImageTest/-1/"
py.sign_in(un, ak)
with self.assertRaises(exceptions.PlotlyError):
py.get_figure(url)
@@ -71,7 +71,7 @@ def test_get_figure_invalid_2(self):
def test_get_figure_invalid_3(self):
un = "PlotlyImageTest"
ak = "786r5mecv0"
- url = "https://plot.ly/~PlotlyImageTest/2/"
+ url = "https://plotly.com/~PlotlyImageTest/2/"
py.sign_in(un, ak)
with self.assertRaises(ValueError):
py.get_figure(url)
@@ -79,7 +79,7 @@ def test_get_figure_invalid_3(self):
def test_get_figure_does_not_exist(self):
un = "PlotlyImageTest"
ak = "786r5mecv0"
- url = "https://plot.ly/~PlotlyImageTest/1000000000/"
+ url = "https://plotly.com/~PlotlyImageTest/1000000000/"
py.sign_in(un, ak)
with self.assertRaises(_plotly_utils.exceptions.PlotlyError):
py.get_figure(url)
@@ -97,6 +97,6 @@ class TestBytesVStrings(PlotlyTestCase):
def test_proper_escaping(self):
un = "PlotlyImageTest"
ak = "786r5mecv0"
- url = "https://plot.ly/~PlotlyImageTest/13185/"
+ url = "https://plotly.com/~PlotlyImageTest/13185/"
py.sign_in(un, ak)
py.get_figure(url)
diff --git a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py
index 1f7c96369f3..7dee479f560 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py
@@ -20,7 +20,7 @@
"plotly-platform": "pythonz",
}
-server = "https://plot.ly"
+server = "https://plotly.com"
class GetRequestsTest(PlotlyTestCase):
diff --git a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_grid/test_grid.py b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_grid/test_grid.py
index ac542e70fb7..1bf6f06ec78 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_grid/test_grid.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_grid/test_grid.py
@@ -34,7 +34,7 @@ class GridTest(PlotlyTestCase):
_grid_id = "chris:3043"
_grid = Grid([])
_grid.id = _grid_id
- _grid_url = "https://plot.ly/~chris/3043/my-grid"
+ _grid_url = "https://plotly.com/~chris/3043/my-grid"
def setUp(self):
super(GridTest, self).setUp()
diff --git a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_meta/test_meta.py b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_meta/test_meta.py
index 2af3ff9df3c..777598c3060 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_meta/test_meta.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_meta/test_meta.py
@@ -54,6 +54,6 @@ def test_upload_meta_with_grid(self):
+ "https://github.com/plotly/python-api/issues/263"
)
def test_metadata_to_nonexistent_grid(self):
- non_exist_meta_url = "https://local.plot.ly/~GridTest/999999999"
+ non_exist_meta_url = "https://local.plotly.com/~GridTest/999999999"
with self.assertRaises(PlotlyRequestError):
py.meta_ops.upload(self._meta, grid_url=non_exist_meta_url)
diff --git a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py
index 087e7c81662..9cf5af55f2d 100644
--- a/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py
+++ b/packages/python/chart-studio/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py
@@ -61,7 +61,7 @@ def test_invalid_code_language(self):
)
def test_expected_pres(self):
- markdown_string = "# title\n---\ntransition: zoom, fade, fade\n# Colors\nColors are everywhere around us.\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nImage(https://raw.githubusercontent.com/jackparmer/gradient-backgrounds/master/moods1.png)\n```python\nx=1\n```\n---\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\n---\n"
+ markdown_string = "# title\n---\ntransition: zoom, fade, fade\n# Colors\nColors are everywhere around us.\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nImage(https://raw.githubusercontent.com/jackparmer/gradient-backgrounds/master/moods1.png)\n```python\nx=1\n```\n---\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\nPlotly(https://plotly.com/~AdamKulidjian/3564/)\n---\n"
my_pres = pres.Presentation(markdown_string, style="moods", imgStretch=True)
@@ -255,7 +255,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 280.0,
"left": 0.0,
@@ -322,7 +322,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
@@ -339,7 +339,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
@@ -356,7 +356,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
@@ -373,7 +373,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
@@ -390,7 +390,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
@@ -407,7 +407,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
@@ -424,7 +424,7 @@ def test_expected_pres(self):
"props": {
"frameBorder": 0,
"scrolling": "no",
- "src": "https://plot.ly/~AdamKulidjian/3564/.embed?link=false",
+ "src": "https://plotly.com/~AdamKulidjian/3564/.embed?link=false",
"style": {
"height": 96.57142857142857,
"left": 400.0,
diff --git a/packages/python/chart-studio/chart_studio/tools.py b/packages/python/chart-studio/chart_studio/tools.py
index 87b23546b33..c27dcb71252 100644
--- a/packages/python/chart-studio/chart_studio/tools.py
+++ b/packages/python/chart-studio/chart_studio/tools.py
@@ -73,7 +73,7 @@ def ensure_local_plotly_files():
"local configuration files. No problem though! You'll "
"just have to sign-in using 'plotly.plotly.sign_in()'. "
"For help with that: 'help(plotly.plotly.sign_in)'."
- "\nQuestions? Visit https://support.plot.ly"
+ "\nQuestions? Visit https://support.plotly.com"
)
@@ -155,9 +155,9 @@ def set_config_file(
):
"""Set the keyword-value pairs in `~/.plotly/.config`.
- :param (str) plotly_domain: ex - https://plot.ly
- :param (str) plotly_streaming_domain: ex - stream.plot.ly
- :param (str) plotly_api_domain: ex - https://api.plot.ly
+ :param (str) plotly_domain: ex - https://plotly.com
+ :param (str) plotly_streaming_domain: ex - stream.plotly.com
+ :param (str) plotly_api_domain: ex - https://api.plotly.com
:param (bool) plotly_ssl_verification: True = verify, False = don't verify
:param (bool) plotly_proxy_authorization: True = use plotly proxy auth creds
:param (bool) world_readable: True = public, False = private
@@ -386,7 +386,7 @@ def embed(file_owner_or_url, file_id=None, width="100%", height=525):
get_config_defaults()["plotly_domain"]
!= session.get_session_config()["plotly_domain"]
):
- feedback_contact = "Visit support.plot.ly"
+ feedback_contact = "Visit support.plotly.com"
else:
# different domain likely means enterprise
diff --git a/packages/python/chart-studio/chart_studio/utils.py b/packages/python/chart-studio/chart_studio/utils.py
index f2fc92c1c15..62c747b1cb2 100644
--- a/packages/python/chart-studio/chart_studio/utils.py
+++ b/packages/python/chart-studio/chart_studio/utils.py
@@ -34,8 +34,8 @@
"with 'https':\n\n\n"
"import plotly\n"
"plotly.tools.set_config_file(\n"
- " plotly_domain='https://plot.ly',\n"
- " plotly_api_domain='https://api.plot.ly'\n"
+ " plotly_domain='https://plotly.com',\n"
+ " plotly_api_domain='https://api.plotly.com'\n"
")\n\n\n"
"If you are using On-Premise then you will need to use your company's "
"domain and api_domain urls:\n\n\n"
@@ -46,7 +46,7 @@
")\n\n\n"
"Make sure to replace `your-company.com` with the URL of your Plotly "
"On-Premise server.\nSee "
- "https://plot.ly/python/getting-started/#special-instructions-for-plotly-onpremise-users "
+ "https://plotly.com/python/getting-started/#special-instructions-for-plotly-onpremise-users "
"for more help with getting started with On-Premise."
)
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/_plotly_utils/utils.py b/packages/python/plotly/_plotly_utils/utils.py
index 19c8a37c349..86adad73099 100644
--- a/packages/python/plotly/_plotly_utils/utils.py
+++ b/packages/python/plotly/_plotly_utils/utils.py
@@ -211,7 +211,7 @@ class NotEncodable(Exception):
def iso_to_plotly_time_string(iso_string):
"""Remove timezone info and replace 'T' delimeter with ' ' (ws)."""
# make sure we don't send timezone info to plotly
- if (iso_string.split("-")[:3] is "00:00") or (iso_string.split("+")[0] is "00:00"):
+ if (iso_string.split("-")[:3] == "00:00") or (iso_string.split("+")[0] == "00:00"):
raise Exception(
"Plotly won't accept timestrings with timezone info.\n"
"All timestrings are assumed to be in UTC."
diff --git a/packages/python/plotly/codegen/__init__.py b/packages/python/plotly/codegen/__init__.py
index 6676744d2a4..a50bacf0b38 100644
--- a/packages/python/plotly/codegen/__init__.py
+++ b/packages/python/plotly/codegen/__init__.py
@@ -259,9 +259,9 @@ def perform_codegen():
from distutils.version import LooseVersion
if LooseVersion(ipywidgets.__version__) >= LooseVersion('7.0.0'):
from ._figurewidget import FigureWidget
+ __all__.append("FigureWidget")
del LooseVersion
del ipywidgets
- __all__.append("FigureWidget")
except ImportError:
pass
"""
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/_widget_version.py b/packages/python/plotly/plotly/_widget_version.py
index ee9406e56f7..c25ef7c0091 100644
--- a/packages/python/plotly/plotly/_widget_version.py
+++ b/packages/python/plotly/plotly/_widget_version.py
@@ -2,4 +2,4 @@
# for automated dev builds
#
# It is edited by hand prior to official releases
-__frontend_version__ = "1.5.3"
+__frontend_version__ = "1.5.4"
diff --git a/packages/python/plotly/plotly/express/_chart_types.py b/packages/python/plotly/plotly/express/_chart_types.py
index ec3e7a3ec22..2466595c31c 100644
--- a/packages/python/plotly/plotly/express/_chart_types.py
+++ b/packages/python/plotly/plotly/express/_chart_types.py
@@ -1234,7 +1234,6 @@ def pie(
template=None,
width=None,
height=None,
- opacity=None,
hole=None,
):
"""
@@ -1423,7 +1422,6 @@ def funnel_area(
template=None,
width=None,
height=None,
- opacity=None,
):
"""
In a funnel area plot, each row of `data_frame` is represented as a
diff --git a/packages/python/plotly/plotly/express/_core.py b/packages/python/plotly/plotly/express/_core.py
index 9d586415633..ff247942a3d 100644
--- a/packages/python/plotly/plotly/express/_core.py
+++ b/packages/python/plotly/plotly/express/_core.py
@@ -188,7 +188,7 @@ def make_trace_kwargs(args, trace_spec, trace_data, mapping_labels, sizeref):
if ((not attr_value) or (name in attr_value))
and (
trace_spec.constructor != go.Parcoords
- or args["data_frame"][name].dtype.kind in "bifc"
+ or args["data_frame"][name].dtype.kind in "ifc"
)
and (
trace_spec.constructor != go.Parcats
@@ -389,6 +389,7 @@ def make_trace_kwargs(args, trace_spec, trace_data, mapping_labels, sizeref):
]:
hover_lines = [k + "=" + v for k, v in mapping_labels.items()]
trace_patch["hovertemplate"] = hover_header + "
".join(hover_lines)
+ trace_patch["hovertemplate"] += ""
return trace_patch, fit_results
@@ -1123,7 +1124,7 @@ def aggfunc_discrete(x):
agg_f[count_colname] = "sum"
if args["color"]:
- if df[args["color"]].dtype.kind not in "bifc":
+ if df[args["color"]].dtype.kind not in "ifc":
aggfunc_color = aggfunc_discrete
discrete_color = True
elif not aggfunc_color:
@@ -1167,8 +1168,13 @@ def aggfunc_continuous(x):
df_tree[cols] = dfg[cols]
df_all_trees = df_all_trees.append(df_tree, ignore_index=True)
+ # we want to make sure than (?) is the first color of the sequence
if args["color"] and discrete_color:
- df_all_trees = df_all_trees.sort_values(by=args["color"])
+ sort_col_name = "sort_color_if_discrete_color"
+ while sort_col_name in df_all_trees.columns:
+ sort_col_name += "0"
+ df_all_trees[sort_col_name] = df[args["color"]].astype(str)
+ df_all_trees = df_all_trees.sort_values(by=sort_col_name)
# Now modify arguments
args["data_frame"] = df_all_trees
@@ -1222,7 +1228,7 @@ def infer_config(args, constructor, trace_patch):
else:
if (
args["color"]
- and args["data_frame"][args["color"]].dtype.kind in "bifc"
+ and args["data_frame"][args["color"]].dtype.kind in "ifc"
):
attrs.append("color")
args["color_is_continuous"] = True
@@ -1440,8 +1446,6 @@ def make_figure(args, constructor, trace_patch={}, layout_patch={}):
)
if trace_spec.constructor in [go.Bar, go.Violin, go.Box, go.Histogram]:
trace.update(alignmentgroup=True, offsetgroup=trace_name)
- if trace_spec.constructor not in [go.Parcats, go.Parcoords]:
- trace.update(hoverlabel=dict(namelength=0))
trace_names.add(trace_name)
# Init subplot row/col
diff --git a/packages/python/plotly/plotly/express/_doc.py b/packages/python/plotly/plotly/express/_doc.py
index 3b153b0587a..4f17af74756 100644
--- a/packages/python/plotly/plotly/express/_doc.py
+++ b/packages/python/plotly/plotly/express/_doc.py
@@ -6,13 +6,6 @@
except AttributeError: # python 2
getfullargspec = inspect.getargspec
-# TODO contents of columns
-# TODO explain categorical
-# TODO handle color
-# TODO handle details of box/violin/histogram
-# TODO handle details of column selection with `dimensions`
-# TODO document "or `None`, default `None`" in various places
-# TODO standardize positioning and casing of 'default'
colref_type = "str or int or Series or array-like"
colref_desc = "Either a name of a column in `data_frame`, or a pandas Series or array_like object."
@@ -325,11 +318,11 @@
],
title=["str", "The figure title."],
template=[
- "or dict or plotly.graph_objects.layout.Template instance",
- "The figure template name or definition.",
+ "str or dict or plotly.graph_objects.layout.Template instance",
+ "The figure template name (must be a key in plotly.io.templates) or definition.",
],
width=["int (default `None`)", "The figure width in pixels."],
- height=["int (default `600`)", "The figure height in pixels."],
+ height=["int (default `None`)", "The figure height in pixels."],
labels=[
"dict with str keys and str values (default `{}`)",
"By default, column names are used in the figure for axis titles, legend entries and hovers.",
@@ -536,5 +529,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/express/_imshow.py b/packages/python/plotly/plotly/express/_imshow.py
index 6f1bf77e877..9ffe6800676 100644
--- a/packages/python/plotly/plotly/express/_imshow.py
+++ b/packages/python/plotly/plotly/express/_imshow.py
@@ -3,6 +3,13 @@
from ._core import apply_default_cascade
import numpy as np
+try:
+ import xarray
+
+ xarray_imported = True
+except ImportError:
+ xarray_imported = False
+
_float_types = []
# Adapted from skimage.util.dtype
@@ -61,6 +68,9 @@ def imshow(
zmin=None,
zmax=None,
origin=None,
+ labels={},
+ x=None,
+ y=None,
color_continuous_scale=None,
color_continuous_midpoint=None,
range_color=None,
@@ -68,6 +78,7 @@ def imshow(
template=None,
width=None,
height=None,
+ aspect=None,
):
"""
Display an image, i.e. data on a 2D regular raster.
@@ -75,7 +86,7 @@ def imshow(
Parameters
----------
- img: array-like image
+ img: array-like image, or xarray
The image data. Supported array shapes are
- (M, N): an image with scalar data. The data is visualized
@@ -90,11 +101,24 @@ def imshow(
a multichannel image of floats, the max of the image is computed and zmax is the
smallest power of 256 (1, 255, 65535) greater than this max value,
with a 5% tolerance. For a single-channel image, the max of the image is used.
+ Overridden by range_color.
origin : str, 'upper' or 'lower' (default 'upper')
position of the [0, 0] pixel of the image array, in the upper left or lower left
corner. The convention 'upper' is typically used for matrices and images.
+ labels : dict with str keys and str values (default `{}`)
+ Sets names used in the figure for axis titles (keys ``x`` and ``y``),
+ colorbar title and hoverlabel (key ``color``). The values should correspond
+ to the desired label to be displayed. If ``img`` is an xarray, dimension
+ names are used for axis titles, and long name for the colorbar title
+ (unless overridden in ``labels``). Possible keys are: x, y, and color.
+
+ x, y: list-like, optional
+ x and y are used to label the axes of single-channel heatmap visualizations and
+ their lengths must match the lengths of the second and first dimensions of the
+ img argument. They are auto-populated if the input is an xarray.
+
color_continuous_scale : str or list of str
colormap used to map scalar data to colors (for a 2D image). This parameter is
not used for RGB or RGBA images. If a string is provided, it should be the name
@@ -103,7 +127,7 @@ def imshow(
color_continuous_midpoint : number
If set, computes the bounds of the continuous color scale to have the desired
- midpoint.
+ midpoint. Overridden by range_color or zmin and zmax.
range_color : list of two numbers
If provided, overrides auto-scaling on the continuous color scale, including
@@ -120,7 +144,15 @@ def imshow(
The figure width in pixels.
height: number
- The figure height in pixels, defaults to 600.
+ The figure height in pixels.
+
+ aspect: 'equal', 'auto', or None
+ - 'equal': Ensures an aspect ratio of 1 or pixels (square pixels)
+ - 'auto': The axes is kept fixed and the aspect ratio of pixels is
+ adjusted so that the data fit in the axes. In general, this will
+ result in non-square pixels.
+ - if None, 'equal' is used for numpy arrays and 'auto' for xarrays
+ (which have typically heterogeneous coordinates)
Returns
-------
@@ -137,23 +169,66 @@ def imshow(
In order to update and customize the returned figure, use
`go.Figure.update_traces` or `go.Figure.update_layout`.
+
+ If an xarray is passed, dimensions names and coordinates are used for
+ axes labels and ticks.
"""
args = locals()
apply_default_cascade(args)
+ labels = labels.copy()
+ if xarray_imported and isinstance(img, xarray.DataArray):
+ y_label, x_label = img.dims[0], img.dims[1]
+ # np.datetime64 is not handled correctly by go.Heatmap
+ for ax in [x_label, y_label]:
+ if np.issubdtype(img.coords[ax].dtype, np.datetime64):
+ img.coords[ax] = img.coords[ax].astype(str)
+ if x is None:
+ x = img.coords[x_label]
+ if y is None:
+ y = img.coords[y_label]
+ if aspect is None:
+ aspect = "auto"
+ if labels.get("x", None) is None:
+ labels["x"] = x_label
+ if labels.get("y", None) is None:
+ labels["y"] = y_label
+ if labels.get("color", None) is None:
+ labels["color"] = xarray.plot.utils.label_from_attrs(img)
+ labels["color"] = labels["color"].replace("\n", "
")
+ else:
+ if labels.get("x", None) is None:
+ labels["x"] = ""
+ if labels.get("y", None) is None:
+ labels["y"] = ""
+ if labels.get("color", None) is None:
+ labels["color"] = ""
+ if aspect is None:
+ aspect = "equal"
img = np.asanyarray(img)
+
# Cast bools to uint8 (also one byte)
if img.dtype == np.bool:
img = 255 * img.astype(np.uint8)
# For 2d data, use Heatmap trace
if img.ndim == 2:
- trace = go.Heatmap(z=img, coloraxis="coloraxis1")
+ if y is not None and img.shape[0] != len(y):
+ raise ValueError(
+ "The length of the y vector must match the length of the first "
+ + "dimension of the img matrix."
+ )
+ if x is not None and img.shape[1] != len(x):
+ raise ValueError(
+ "The length of the x vector must match the length of the second "
+ + "dimension of the img matrix."
+ )
+ trace = go.Heatmap(x=x, y=y, z=img, coloraxis="coloraxis1")
autorange = True if origin == "lower" else "reversed"
- layout = dict(
- xaxis=dict(scaleanchor="y", constrain="domain"),
- yaxis=dict(autorange=autorange, constrain="domain"),
- )
+ layout = dict(yaxis=dict(autorange=autorange))
+ if aspect == "equal":
+ layout["xaxis"] = dict(scaleanchor="y", constrain="domain")
+ layout["yaxis"]["constrain"] = "domain"
colorscale_validator = ColorscaleValidator("colorscale", "imshow")
if zmin is not None and zmax is None:
zmax = img.max()
@@ -168,6 +243,8 @@ def imshow(
cmin=range_color[0],
cmax=range_color[1],
)
+ if labels["color"]:
+ layout["coloraxis1"]["colorbar"] = dict(title=labels["color"])
# For 2D+RGB data, use Image trace
elif img.ndim == 3 and img.shape[-1] in [3, 4]:
@@ -185,12 +262,20 @@ def imshow(
)
layout_patch = dict()
- for v in ["title", "height", "width"]:
- if args[v]:
- layout_patch[v] = args[v]
+ for attr_name in ["title", "height", "width"]:
+ if args[attr_name]:
+ layout_patch[attr_name] = args[attr_name]
if "title" not in layout_patch and args["template"].layout.margin.t is None:
layout_patch["margin"] = {"t": 60}
fig = go.Figure(data=trace, layout=layout)
fig.update_layout(layout_patch)
+ fig.update_traces(
+ hovertemplate="%s: %%{x}
%s: %%{y}
%s: %%{z}"
+ % (labels["x"] or "x", labels["y"] or "y", labels["color"] or "color",)
+ )
+ if labels["x"]:
+ fig.update_xaxes(title_text=labels["x"])
+ if labels["y"]:
+ fig.update_yaxes(title_text=labels["y"])
fig.update_layout(template=args["template"], overwrite=True)
return fig
diff --git a/packages/python/plotly/plotly/figure_factory/_candlestick.py b/packages/python/plotly/plotly/figure_factory/_candlestick.py
index 2ab76122530..04264962adb 100644
--- a/packages/python/plotly/plotly/figure_factory/_candlestick.py
+++ b/packages/python/plotly/plotly/figure_factory/_candlestick.py
@@ -191,12 +191,12 @@ def create_candlestick(open, high, low, close, dates=None, direction="both", **k
utils.validate_equal_length(open, high, low, close)
validate_ohlc(open, high, low, close, direction, **kwargs)
- if direction is "increasing":
+ if direction == "increasing":
candle_incr_data = make_increasing_candle(
open, high, low, close, dates, **kwargs
)
data = candle_incr_data
- elif direction is "decreasing":
+ elif direction == "decreasing":
candle_decr_data = make_decreasing_candle(
open, high, low, close, dates, **kwargs
)
diff --git a/packages/python/plotly/plotly/figure_factory/_ohlc.py b/packages/python/plotly/plotly/figure_factory/_ohlc.py
index 49ca1aa196a..fe8cb7ae9f8 100644
--- a/packages/python/plotly/plotly/figure_factory/_ohlc.py
+++ b/packages/python/plotly/plotly/figure_factory/_ohlc.py
@@ -173,10 +173,10 @@ def create_ohlc(open, high, low, close, dates=None, direction="both", **kwargs):
utils.validate_equal_length(open, high, low, close)
validate_ohlc(open, high, low, close, direction, **kwargs)
- if direction is "increasing":
+ if direction == "increasing":
ohlc_incr = make_increasing_ohlc(open, high, low, close, dates, **kwargs)
data = [ohlc_incr]
- elif direction is "decreasing":
+ elif direction == "decreasing":
ohlc_decr = make_decreasing_ohlc(open, high, low, close, dates, **kwargs)
data = [ohlc_decr]
else:
diff --git a/packages/python/plotly/plotly/graph_objs/__init__.py b/packages/python/plotly/plotly/graph_objs/__init__.py
index ee0cde75f81..52d6e529fd6 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
@@ -100182,8 +100293,9 @@ def __init__(
if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
from ._figurewidget import FigureWidget
+
+ __all__.append("FigureWidget")
del LooseVersion
del ipywidgets
- __all__.append("FigureWidget")
except ImportError:
pass
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/io/_orca.py b/packages/python/plotly/plotly/io/_orca.py
index 96f3ec5d6f8..500674b6281 100644
--- a/packages/python/plotly/plotly/io/_orca.py
+++ b/packages/python/plotly/plotly/io/_orca.py
@@ -1429,7 +1429,10 @@ def ensure_server():
# specified port.
DEVNULL = open(os.devnull, "wb")
with orca_env():
- orca_state["proc"] = subprocess.Popen(cmd_list, stdout=DEVNULL)
+ stderr = DEVNULL if "CI" in os.environ else None # fix for CI
+ orca_state["proc"] = subprocess.Popen(
+ cmd_list, stdout=DEVNULL, stderr=stderr
+ )
# Update orca.status so the user has an accurate view
# of the state of the orca server
diff --git a/packages/python/plotly/plotly/io/_renderers.py b/packages/python/plotly/plotly/io/_renderers.py
index 2341339d028..5277c9efec7 100644
--- a/packages/python/plotly/plotly/io/_renderers.py
+++ b/packages/python/plotly/plotly/io/_renderers.py
@@ -497,6 +497,12 @@ def show(fig, renderer=None, validate=True, **kwargs):
# orca not found
pass
+ # Check if we're running in ipython terminal
+ if not default_renderer and (
+ ipython.get_ipython().__class__.__name__ == "TerminalInteractiveShell"
+ ):
+ default_renderer = "browser"
+
# Fallback to renderer combination that will work automatically
# in the classic notebook (offline), jupyterlab, nteract, vscode, and
# nbconvert HTML export.
diff --git a/packages/python/plotly/plotly/matplotlylib/renderer.py b/packages/python/plotly/plotly/matplotlylib/renderer.py
index 1a4ef289097..a2f749c719b 100644
--- a/packages/python/plotly/plotly/matplotlylib/renderer.py
+++ b/packages/python/plotly/plotly/matplotlylib/renderer.py
@@ -457,7 +457,7 @@ def draw_path_collection(self, **props):
"""
self.msg += " Attempting to draw a path collection\n"
- if props["offset_coordinates"] is "data":
+ if props["offset_coordinates"] == "data":
markerstyle = mpltools.get_markerstyle_from_collection(props)
scatter_props = {
"coordinates": "data",
@@ -569,7 +569,7 @@ def draw_text(self, **props):
self.draw_title(**props)
else: # just a regular text annotation...
self.msg += " Text object is a normal annotation\n"
- if props["coordinates"] is not "data":
+ if props["coordinates"] != "data":
self.msg += (
" Text object isn't linked to 'data' " "coordinates\n"
)
diff --git a/packages/python/plotly/plotly/tests/test_core/test_px/test_imshow.py b/packages/python/plotly/plotly/tests/test_core/test_px/test_imshow.py
index e296a958f3a..7f8c2afd48b 100644
--- a/packages/python/plotly/plotly/tests/test_core/test_px/test_imshow.py
+++ b/packages/python/plotly/plotly/tests/test_core/test_px/test_imshow.py
@@ -1,6 +1,7 @@
import plotly.express as px
import numpy as np
import pytest
+import xarray as xr
img_rgb = np.array([[[255, 0, 0], [0, 255, 0], [0, 0, 255]]], dtype=np.uint8)
img_gray = np.arange(100).reshape((10, 10))
@@ -58,8 +59,9 @@ def test_colorscale():
def test_wrong_dimensions():
imgs = [1, np.ones((5,) * 3), np.ones((5,) * 4)]
+ msg = "px.imshow only accepts 2D single-channel, RGB or RGBA images."
for img in imgs:
- with pytest.raises(ValueError) as err_msg:
+ with pytest.raises(ValueError, match=msg):
fig = px.imshow(img)
@@ -114,3 +116,37 @@ def test_zmin_zmax_range_color():
fig = px.imshow(img, zmax=0.8)
assert fig.layout.coloraxis.cmin == 0.0
assert fig.layout.coloraxis.cmax == 0.8
+
+
+def test_imshow_xarray():
+ img = np.random.random((20, 30))
+ da = xr.DataArray(img, dims=["dim_rows", "dim_cols"])
+ fig = px.imshow(da)
+ # Dimensions are used for axis labels and coordinates
+ assert fig.layout.xaxis.title.text == "dim_cols"
+ assert fig.layout.yaxis.title.text == "dim_rows"
+ assert np.all(np.array(fig.data[0].x) == np.array(da.coords["dim_cols"]))
+
+
+def test_imshow_labels_and_ranges():
+ fig = px.imshow([[1, 2], [3, 4], [5, 6]],)
+ assert fig.layout.xaxis.title.text is None
+ assert fig.layout.yaxis.title.text is None
+ assert fig.layout.coloraxis.colorbar.title.text is None
+ assert fig.data[0].x is None
+ assert fig.data[0].y is None
+ fig = px.imshow(
+ [[1, 2], [3, 4], [5, 6]],
+ x=["a", "b"],
+ y=["c", "d", "e"],
+ labels=dict(x="the x", y="the y", color="the color"),
+ )
+ # Dimensions are used for axis labels and coordinates
+ assert fig.layout.xaxis.title.text == "the x"
+ assert fig.layout.yaxis.title.text == "the y"
+ assert fig.layout.coloraxis.colorbar.title.text == "the color"
+ assert fig.data[0].x[0] == "a"
+ assert fig.data[0].y[0] == "c"
+
+ with pytest.raises(ValueError):
+ fig = px.imshow([[1, 2], [3, 4], [5, 6]], x=["a"])
diff --git a/packages/python/plotly/plotly/tests/test_core/test_px/test_px.py b/packages/python/plotly/plotly/tests/test_core/test_px/test_px.py
index b4880899e95..60699e6e21d 100644
--- a/packages/python/plotly/plotly/tests/test_core/test_px/test_px.py
+++ b/packages/python/plotly/plotly/tests/test_core/test_px/test_px.py
@@ -50,7 +50,7 @@ def test_custom_data_scatter():
assert fig.data[0].customdata.shape[1] == 4
assert (
fig.data[0].hovertemplate
- == "sepal_width=%{x}
sepal_length=%{y}
petal_length=%{customdata[2]}
petal_width=%{customdata[3]}
species_id=%{customdata[0]}"
+ == "sepal_width=%{x}
sepal_length=%{y}
petal_length=%{customdata[2]}
petal_width=%{customdata[3]}
species_id=%{customdata[0]}"
)
diff --git a/packages/python/plotly/plotly/tests/test_core/test_px/test_px_input.py b/packages/python/plotly/plotly/tests/test_core/test_px/test_px_input.py
index 8062dd78fc3..e3786f6af90 100644
--- a/packages/python/plotly/plotly/tests/test_core/test_px/test_px_input.py
+++ b/packages/python/plotly/plotly/tests/test_core/test_px/test_px_input.py
@@ -29,17 +29,23 @@ def test_numpy_labels():
fig = px.scatter(
x=[1, 2, 3], y=[2, 3, 4], labels={"x": "time"}
) # other labels will be kw arguments
- assert fig.data[0]["hovertemplate"] == "time=%{x}
y=%{y}"
+ assert fig.data[0]["hovertemplate"] == "time=%{x}
y=%{y}"
def test_with_index():
tips = px.data.tips()
fig = px.scatter(tips, x=tips.index, y="total_bill")
- assert fig.data[0]["hovertemplate"] == "index=%{x}
total_bill=%{y}"
+ assert (
+ fig.data[0]["hovertemplate"] == "index=%{x}
total_bill=%{y}"
+ )
fig = px.scatter(tips, x=tips.index, y=tips.total_bill)
- assert fig.data[0]["hovertemplate"] == "index=%{x}
total_bill=%{y}"
+ assert (
+ fig.data[0]["hovertemplate"] == "index=%{x}
total_bill=%{y}"
+ )
fig = px.scatter(tips, x=tips.index, y=tips.total_bill, labels={"index": "number"})
- assert fig.data[0]["hovertemplate"] == "number=%{x}
total_bill=%{y}"
+ assert (
+ fig.data[0]["hovertemplate"] == "number=%{x}
total_bill=%{y}"
+ )
# We do not allow "x=index"
with pytest.raises(ValueError) as err_msg:
fig = px.scatter(tips, x="index", y="total_bill")
@@ -49,28 +55,34 @@ def test_with_index():
tips = px.data.tips()
tips.index.name = "item"
fig = px.scatter(tips, x=tips.index, y="total_bill")
- assert fig.data[0]["hovertemplate"] == "item=%{x}
total_bill=%{y}"
+ assert fig.data[0]["hovertemplate"] == "item=%{x}
total_bill=%{y}"
def test_pandas_series():
tips = px.data.tips()
before_tip = tips.total_bill - tips.tip
fig = px.bar(tips, x="day", y=before_tip)
- assert fig.data[0].hovertemplate == "day=%{x}
y=%{y}"
+ assert fig.data[0].hovertemplate == "day=%{x}
y=%{y}"
fig = px.bar(tips, x="day", y=before_tip, labels={"y": "bill"})
- assert fig.data[0].hovertemplate == "day=%{x}
bill=%{y}"
+ assert fig.data[0].hovertemplate == "day=%{x}
bill=%{y}"
# lock down that we can pass df.col to facet_*
fig = px.bar(tips, x="day", y="tip", facet_row=tips.day, facet_col=tips.day)
- assert fig.data[0].hovertemplate == "day=%{x}
tip=%{y}"
+ assert fig.data[0].hovertemplate == "day=%{x}
tip=%{y}"
def test_several_dataframes():
df = pd.DataFrame(dict(x=[0, 1], y=[1, 10], z=[0.1, 0.8]))
df2 = pd.DataFrame(dict(time=[23, 26], money=[100, 200]))
fig = px.scatter(df, x="z", y=df2.money, size="x")
- assert fig.data[0].hovertemplate == "z=%{x}
y=%{y}
x=%{marker.size}"
+ assert (
+ fig.data[0].hovertemplate
+ == "z=%{x}
y=%{y}
x=%{marker.size}"
+ )
fig = px.scatter(df2, x=df.z, y=df2.money, size=df.z)
- assert fig.data[0].hovertemplate == "x=%{x}
money=%{y}
size=%{marker.size}"
+ assert (
+ fig.data[0].hovertemplate
+ == "x=%{x}
money=%{y}
size=%{marker.size}"
+ )
# Name conflict
with pytest.raises(NameError) as err_msg:
fig = px.scatter(df, x="z", y=df2.money, size="y")
@@ -85,7 +97,7 @@ def test_several_dataframes():
fig = px.scatter(x=df.y, y=df2.y)
assert np.all(fig.data[0].x == np.array([3, 4]))
assert np.all(fig.data[0].y == np.array([23, 24]))
- assert fig.data[0].hovertemplate == "x=%{x}
y=%{y}"
+ assert fig.data[0].hovertemplate == "x=%{x}
y=%{y}"
df = pd.DataFrame(dict(x=[0, 1], y=[3, 4]))
df2 = pd.DataFrame(dict(x=[3, 5], y=[23, 24]))
@@ -93,7 +105,10 @@ def test_several_dataframes():
fig = px.scatter(x=df.y, y=df2.y, size=df3.y)
assert np.all(fig.data[0].x == np.array([3, 4]))
assert np.all(fig.data[0].y == np.array([23, 24]))
- assert fig.data[0].hovertemplate == "x=%{x}
y=%{y}
size=%{marker.size}"
+ assert (
+ fig.data[0].hovertemplate
+ == "x=%{x}
y=%{y}
size=%{marker.size}"
+ )
df = pd.DataFrame(dict(x=[0, 1], y=[3, 4]))
df2 = pd.DataFrame(dict(x=[3, 5], y=[23, 24]))
@@ -102,7 +117,8 @@ def test_several_dataframes():
assert np.all(fig.data[0].x == np.array([3, 4]))
assert np.all(fig.data[0].y == np.array([23, 24]))
assert (
- fig.data[0].hovertemplate == "x=%{x}
y=%{y}
hover_data_0=%{customdata[0]}"
+ fig.data[0].hovertemplate
+ == "x=%{x}
y=%{y}
hover_data_0=%{customdata[0]}"
)
@@ -111,7 +127,7 @@ def test_name_heuristics():
fig = px.scatter(df, x=df.y, y=df.x, size=df.y)
assert np.all(fig.data[0].x == np.array([3, 4]))
assert np.all(fig.data[0].y == np.array([0, 1]))
- assert fig.data[0].hovertemplate == "y=%{marker.size}
x=%{y}"
+ assert fig.data[0].hovertemplate == "y=%{marker.size}
x=%{y}"
def test_repeated_name():
@@ -133,7 +149,7 @@ def test_arrayattrable_numpy():
)
assert (
fig.data[0]["hovertemplate"]
- == "total_bill=%{x}
tip=%{y}
hover_data_0=%{customdata[0]}"
+ == "total_bill=%{x}
tip=%{y}
hover_data_0=%{customdata[0]}"
)
tips = px.data.tips()
fig = px.scatter(
@@ -145,7 +161,7 @@ def test_arrayattrable_numpy():
)
assert (
fig.data[0]["hovertemplate"]
- == "total_bill=%{x}
tip=%{y}
suppl=%{customdata[0]}"
+ == "total_bill=%{x}
tip=%{y}
suppl=%{customdata[0]}"
)
@@ -275,7 +291,7 @@ def test_int_col_names():
def test_data_frame_from_dict():
fig = px.scatter({"time": [0, 1], "money": [1, 2]}, x="time", y="money")
- assert fig.data[0].hovertemplate == "time=%{x}
money=%{y}"
+ assert fig.data[0].hovertemplate == "time=%{x}
money=%{y}"
assert np.all(fig.data[0].x == [0, 1])
@@ -306,4 +322,4 @@ def test_pass_df_columns():
def test_size_column():
df = px.data.tips()
fig = px.scatter(df, x=df["size"], y=df.tip)
- assert fig.data[0].hovertemplate == "size=%{x}
tip=%{y}"
+ assert fig.data[0].hovertemplate == "size=%{x}
tip=%{y}"
diff --git a/packages/python/plotly/plotly/tests/test_orca/images/linux/failed/fig1.eps b/packages/python/plotly/plotly/tests/test_orca/images/linux/failed/fig1.eps
index 99ff8d27f49..f46e4ec9cce 100644
--- a/packages/python/plotly/plotly/tests/test_orca/images/linux/failed/fig1.eps
+++ b/packages/python/plotly/plotly/tests/test_orca/images/linux/failed/fig1.eps
@@ -1,10 +1,10 @@
%!PS-Adobe-3.0 EPSF-3.0
%Produced by poppler pdftops version: 0.65.0 (http://poppler.freedesktop.org)
-%%Creator: Chromium
+%%Creator: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) orca/1.3.0 Chrome/76.0.3809.146 Electron/6.1.7 Safari/537.36
%%LanguageLevel: 2
%%DocumentSuppliedResources: (atend)
%%BoundingBox: 0 0 529 379
-%%HiResBoundingBox: 0 0 529 379
+%%HiResBoundingBox: 0 0 528.95996 378.95999
%%DocumentSuppliedResources: (atend)
%%EndComments
%%BeginProlog
@@ -447,13 +447,13 @@ xpdf begin
pdfStartPage
%%EndPageSetup
gsave
-[528.96 0 0 378.96 0 0] concat
+[528.72 0 0 378.72 0 0] concat
/DeviceRGB setcolorspace
<<
/ImageType 1
- /Width 2204
- /Height 1579
- /ImageMatrix [2204 0 0 -1579 0 1579]
+ /Width 2203
+ /Height 1578
+ /ImageMatrix [2203 0 0 -1578 0 1578]
/BitsPerComponent 8
/Decode [0 1 0 1 0 1]
/DataSource currentfile
@@ -517,1486 +517,1245 @@ V&F?Q)R6C_nZa#f[2X+r)mR'qn\H2"`>im>*3ma.n^/@3eK&Y_*O4E@n_kNDjW8F+
nhD@E2'[-%,I0HWnj+NV73lnF,dL,inkg\g<@)Zg-*gf&nmNk#AL;G3-F.J8no6$4
FXM3T-aJ.Jnpr2EKd^tu.'eg\nrY@VPppaA.C,Knnt@NgV(-Mb.^H0+o!']#[4?:.
/$ci=o"ck4`@Q&O/@*MOo$K$EeLbgp/[F1ao&22VjXtT<0!ajso'n@goe1@]0=(O0
-o)UO$"YanI+2RjsiVFY&&0I)P0qnJ!JbU1p'i>)R4rXo3=+5oBie)h6NrYsgW
-5[it>+nINHs$h_W+q!QZAA`#3W32BdG[62hSV^)u;X#!r5#+@AMh2+$4F+5m,!
-e=B2GT0hH]+5mYri=lD\rXrUY4Hmc%+WqlcX;9do*.a\'iT)!;s$*l)9sWG/'/q]*
-`Yh)A)'Lm[iEcu0rY,@.+5nUQ<0'[<$UVZ56QlF1oV58?V@W_M+5mD*Zo^Uj'Ek-/
-'#8f8iC"$HrYAGD)50JU_4r`lfhL!g/6kq*]Pa2kG/0EgO8[T(0
-Pn?W2F\5YZr%U&<4/8J'0mVti#gq9*-6cOU&Gnf
--6M2=$?[@e'mEMTHX&GM>]n:g+V4a^a9uGU)0G9e;huJdbSVp)FXn///)K+5q;PF)*hq`#0;h7lBgH
-nuFe0rZ&bI+5rk,egq>rJdXF5#*bNap0hC\AR+1#Y*UKHK/!8APoA'n'iJokQH*&6,]'1q!U19F3N;&Ca_t
-G0t:bPTN3Y2F1h9ZbR0G:IsD.6@^^iQMGS[Y@[e;;5"=!'T[/5,=J5B5!cOl&XOg[5i4G`a`UEX
-*S6j-pRumlV0[?bHFL#&pT]'([!W!T4n_NZLKX(*W#[T_KTp3!fW`&3q]e_#a[HrDoWjGS`5kfN&%Sr"*6g
-+/'/HiV4"X=T:?Mms,QR(\G<`Jf&`N4@,kpsG'\eW"h,NO[f(pu.5mjc4TMNjp>T6-LAN
-\/?IN)8TJtTmRHgn.e40+(6W(=C[&X+-BZ0L%ua5i#Rq:45\T*q'FdDiIQT9>X
-q0eVjH^K)0R$iYq\WN9TQ'g6mR5pb)H(CBaTpg8!R^o8`fr:G9[@91eRi/o/H,#iZ
-_45eiS@QP-q8o0Fc(-lJSU'%^=lGp^j.6#-T"4*Wq<+A1m@RPOT6Zul\**f1"Q;BB
-TXkT*q@TD^'qopkTt283]
-fIRsbhAd]>O$SpM@@.cql5--2*oU?5Jb0VkRNI)#"h>eSpg%>'=ona$&AU=KJJ\Q!
-pJSio(1?PO6)#-@/#mopWk,=4pn+23ql>#g:=9\`N2,BX;]?bHI&\(dB.`F
-Xh)u`qUr"ih6&g'Y'TK<>4Jc,o<.r_YIUX5(V+gQ!G"La*]24a!WF+U^M!ZI*44!1
-pCJ7ZAThKI+5qqdeclWu_`V?p70+qE1a3'KJW]e]>W6pr'LWSG5SR2o(c523!KHtcOZb$%A]=YVcqmX4"]t@Rc]R.o9]@"9\e\(e2]fXo\qq\tJgV/$n^745u
-]CEW4otK2V^H;>-Hi:`B!Pj'^^q9idg^1dn[BNM(EKnjF*[/dEPis$:?X9?gZG@S(iHPnrl$5Fb+5oB>
-_(Z+FrXtlB`,lt&S57J?LYG,pg-K"-Sphd\K0&fm=*mY^>\INjmE'1
-mQTn'rp@JW3=kcB<>5!Hr#J%RrZ)YLj?`b^1k6@J]BJ*u730M_geH.\(K%e?d@PFk
-QU,R3?TkaP(dSu\s#our5P-+H&@O,#U&GhY$5FVF'0X>I2_37?+&UNDCO^'ls(D%R
-#S<=UpN:-BI1-ZDRr?eBZsD)@e/B-2s*7m'dl*+>F.kBgP;)66mlp(6rpfk-Xnt>n
-qgZVlsTM`egF$9UKp
-&+m*brf7gZd388\#U]R;KqIS&)uV$:J#5aIoa*YXW%L(Wogs=]
-=K9p$"N\+KrfJ$^d:,WB3)aB)^X@a)qP_40@&"h2Q+R"5aa^mjn+Va.rq:P#h_/(.
-p%n^/A+CKWQ;8rpb@U8_SCVU=S^1s@)BBTS8YsmMobsB%Y?A!ZC\A\fQHs9QgMN1n
-eMcT7]&%B"g`>hoJ]-MeGoV97)k"h1o(h)_LJOPml#jS.Ib/5Cf^F"\rSIj@`T?Ub
-r18s.VqLD1HG1HXO2'fLqL/?mT==.Vqu8mb"8Ms^n/MN35k$TD!l8hD)$N=0")eK4
-E24ul6L_oL%7>*q3tF^K"@EbhE?n0j7.EZD'h*+Q>8K`uKOYlhEMR@h7e+E<*Ck,1
-HQPcK"G7jgE[6Pf8Ff04*$9shrcak[q8-X6k*]>$R&$/L>E9-<]RQ/4Jc8B"BDF"r
-Xijo%70H-V%M#,l+s9.&'5ZP^.*=h`25Fb;raliLq64'Fk4++SS>L?+Csc3jeO?#[
-$.*E/k;f>fS-Cb>>T`*j6.\QKFPQUjgNHls?/p-8=,#ga?FRoHQVF]iG"eI
-ir!TG#+[o_b*;JhJ"27(SL>Ol;>t_XF?L7R(K.oOOK!gtr^hjC5XV:j4:rnXTB,L%
-OABI;,>B9C0r(c6kLoBjo)-Nac#[m%'8(B(pHsT*I0W?kFM11?eTBV[;qCViG@T9K
-I=H%cG29"fc?F^"Hf'&H#D:u[IOC'6GlC3sj`u;fS*,(rLSO*6fSW7o?Wr
-ct_npq6jU%Kk^Nr&sZAW\s%^q$A4E_MACr.TZRh"&V2Uk^BR4(0X;#CP!?o6:
-2%T5'+Vg3%;QEoCR^)]R#Q*%+,Q)hIOo@D]dq`fqKhT>DU8CmWEZ:'B\@'``4GPor
-*M[bu%0Zeb8,14?C:.-#YeiiG$\9Dc&Msea!%:JOXpi\0IuMnX2b!kt>,0_oR"H+V
-?CXrOO]EtV2ffa?`*7ETFtH/H\JO9?@>p>#1Ia@M).Q'MND[,@`q.Xoj-4VFOk)Ta
-Gjuhbe9d7=p-2(C!?bneK9262i"(D##%6*?(aQas8Eh7p>Kc7GJW-U_6C?bcZSs#K
-Zk!];!!C:=oH3P[MEep4=W1D>$KQ`"&k+uK`i-+V6MQ%j0pa)X9Ik^lW.,?<(BfNO
-qB+bUH+dY;jP+e"8`g;!X_"_#8"fl(6f):nOm<+n)1NS_`5q#_Z^(8nh0WHKdjIN8[2b`*G-q
-K()&5X>E?E6b)/TTi.n6kH(B5K)JJJ5?j\'@?O`iMbQKo."Lk2_?`7
-b"XUCra2-e^K4m0@tI^>`mreWA*X#$0ro&k%rpVh-P3m$%ImiOiYPFTTRpfE0X7II
-m4ciUU6>Q
-doq)qC2HtO[?e8Q>5M`EV5;rf<$3*QVbr[Wj@_RLlt<2JP2%`Da%
-W.Y"8!P(jE$ScTQ6G_3d,H=pmQJD"\OZ(fL`L
->VUs%eeZ/jB+En3)2#10,K,t9'4Q>dMK)ZI`L++N@f0VK-I(ea'iOd`KlHlt+TI^e
-+hiepIRWf;5Tj-57fp;nF;`:c/[m)K9$p`XL\S.a[sjbS_GE+cHW*i&((NWq(Bs;3
-goI3iB>QRV1'GIl%n0n]"=NkDrO6)\oAUXY#`GZ\a)1=ZH-'Y"E?
-5Kr>\V&1+G!+T3uH?MX?!._7q!(r>=:_rMboGEJ*,SKWWQY,=UOV8L?_,i-flL_kr
-okFiNL=r1A75n@:r(D[UDOede'tN&F8\`JrI,[,Z;X.mLC0ff2;9kH`RS.tk:$oZ=
-`r"WipO-uIq7kaoo&-#SK5c8O_K],iiLDi^E;gtj2R/-n"4C_sWsbQ?1bbOIaX`2k
-r[gL69kMMt_6erZP4!aC&cfHtVK+@iM\T#(iZ*H,nOQ`;i?Y]!=IUr[LEmFt7u
-S7c$qb3Bh#=RZ$Fln-^C\]Ed"o5)GCa]S_:Q:0?gM'bZ?C];g2*Zk
-m@C_qG5gIUH^AgAS_(JtFCeP91asFVZ55dZo9TZA3#K;Y>u_U2:s-u^9V`4h?_SXa
-g,haT,!Q&6]\k5rn?L-L(h>KG#@+.t05aM5;pW"N[+Q6sKt2T"^kHr%Y/EDc^.)!q
-c+UV0*lGXcr,7Nfs4."e_r4mj[<@UjnpX*Pq#<;7I.*KprdVl_T3(?,J$J]rfA$1p
-GOJD_]>^VoI<#"sJ,/X6/Z]5RP8_.VXAU@7aA@TAJe)m;cQqGe2>l^_f:tBjU,j6P
-.;BPYg'XjkXZ?cNR`V\4K:]c'UD^,15MH+9lWK,oZb>+9#&ABFqI`"i&2Y'b5)^+<
-KG-Wk'>Z466!P-jC_WW1&Aa;C6(AiZX;aI<*'qdh6.jR/PLPo._$hQ^LMNN;;Jq6l
-0*\anZGBA8.8lUB3"s-C$^:HFdf#V,kebL(Mct;(8kk16W[`?YL4^H[`"/GrX#_A:
-"Yc'q.k%\;/jGKo,kGpTj/8o.56UdK,\tu#Jg`qG5V-F]6$tu://L]26:8nEJ$+)#`&t+H`40P_IME;n?GdJR9
--*sB@$A_NE"Bq)f-_MnO_Kd[m\5JiC>Tk6,U3YssFC>CmDhb:.L+t6]po_SVmL9"j>3(h)(oWA0pY4Ct9\p4F*,Qql\$VA3%]?$fVpVgo13=Ct['T,E]
-B>sco+N_21U0Y!%]rKKDWmeYdRLKtCi&L45PNs:,g7bpq6_sLc0#3FNkZS(PhNX7P
-8_PW6A=l@sTLVDCao%i)/>>a!7EOVe8mJ5cCo9mQW(N#J2j%r"XCF%"dt_BF`X+,Q
-ZC-E.2[c$bLt]VSCQfZ(3B:<@6HdOu3/n4%=XUF^Q&&t(a]clp\sl&?WG4c3gXDg3
-Y(a\E.U4OJ>Esk&r^iJLQ4QiM&Q]`pN5P9t2M%2[<2n*PO%Mg88fZ,Mgs8[DcqNfQ
-bkh]?`7%FCe4iWe9jH7DCtB_$]u]aVT+k/;3N/TE-os=`TF1%s7"e*H>adoGS12@5
-Ln[>eh?G.D#(/Las_rlMlcn
-@4jQ(']DhCj,K4C"MYQVX%_-kWG]s#r(Rn(9dK^6bl5rDs%j!qcauO%Z"u`F)?VYXsb;[`E!e[?=ESWhILa8.0Z=('2+'$CSR5E/$W-ajdF>
-;iFS"'u(DoQI8*oPA%X&Tr6,;L)P)dS1)H00;j@Y_j(S%&m!,d*6(je]CQ1Um0;!a
-)c.7Kd[_gbXT284.T4599_Bf3m4VB90N/E8;]RVTX9L"$\A35E.uP:O'/ME=Ba%Eu
-"A7UH/Ab:%5T2.m/)tW5Jt=85=\]r&CiA_D(Sb9/Cf_]ZK$S3,GTdss!%:^^-/d@a7L/:VMqjN<=,RW2%^r%Fc_)_]T=p.^=
-4i;?\JbD)Ha=P\uR)R%6T
-;E!$``V#Bq.Ai!u0bY[&0"U;sb?6@d^JYuGc0V`:Pd!dLRPD_k#9[W^8AM*>)(%KB
-/NU&CMe9^;Tu&NN'K"o!1*"^J\"tl`6JC\@pfK>r]Z*=23W]UimB6qXM:dNe>7Il?
-NO)h0ZeHnngASHaD7<_t\6Fs'>BLl&ENM-?5T[1H;,*3IG[5sl;HsC?V_]b_F8@0a
-]ngIF[E(\B[;64:2GY=KMU8LRWZt%*d628@634JfHtt$"1t2(I.N,$E`Gr$>I%-P,
-.uS),eY1`g?/&B4>>)2lf/0+*/
-F.6;pj0A"9-#ISD1YX"O*tu?::C/\<%;?!>VZlVp>f7+(jQ@Y$GI6\Lc[B@P(q`g(
-h9mj_abdj:Qr48ZB07[##8ItF4?jmhiR9C6?le'2/_o8J!anJ"4uNE!D?jQu#[iZ!
-@%2p$]b[a+ObO$#=hIcAnpo3!hR[G_54**MpU>h`%cjPE3-g/K7=
-Z+-Xr:7eL@>#Z"]K5KBiBt_H@"@>o-1Em!"03fOgZJk2a:'smR"QGFFigp<_Xsmhg
-.Q^rainc:smOr&K0OkGV.p?=2'!eAH-E>S^TR)!?C7)J/*i_kt4IO%,KD[2>Qmr4g
-Vh=\!@Ah0Cd*?]KaRa#Tg8iEu.opt;fj$$l`/#="ZUV3#?>PV#C+3G;0hk\!jPDHK
-mOVoJ:1XW**;3(f/lQ=F<+Sg)AQasaWbK(`8`PoZ!Aa\Bk1pI"2TgUjSfdUpnSo&4SWjC1mAU\m?:&2e1o
-jIo8\C[kA1<_ABKk?_$KDGb%qG%ZPR,E?m/Y'XfqHtU`QBA!\t]K]81FGBR!Tno2;
-NX\IfTo(E6]pZVT4\XWp?Y/n(Z?'Ea$K+u:D<>nN+DoXUBR)]*):^_o]%X=,1XjIr
-p>L%5MN#!L>#I]ApI/LB_p.8rXIT5ZD-BVLuY9):-9oW*+5I,ZmGu453f7a7VoW>K^MDuEmN1>)0&Z.ZZu,g(DI2ICDWbnb8i%1Ue;R7B
-WFuT$^l+U60=XcLD9u+l/;,6P4H-TRLf=`,oh5H=*NY"Hk9oX;\`.
-_b+Opo7:I=+Q,I%SQ/YKLti
-fX^nM1?Zq$Vd,rWR.#3dZ/0J4/,)\ALc*Fo#Q42Mdl9"pA2t]`emdJj[.h-Qhb\*%
-`\MD7GAgN!_7&YR9/98U_K\fA^>BIq]>ad@F[+^M
--i81@s'_\[lB:3+/j"QY"jcg+IK"m-^X1r[qC"]18IQ^+j"((mRX_jcO8!F4rq1HT
-X4@(NL;dZ.=_uZ97AeUN[TdV"qh<$NVC&:FQYW_[om+8X0A!i7pAoo_@;n2R-6itV
-`a\JjXG/YYO3(sRR=(T=/Xjmqo@_q(F%)_Kk]E8A2Q'3Ke8$pFh1i[UY1d]8]03Uc
-EP'uoG?aIss+S;KE&cW:58THO\T<&OreF"?e*;(%h1!CW[G1+nHen],LW/I%TTT&cPrD0[)Hb.H+-i#qP+68f$UkD86$k8ii
-&1J>^+u0($%]B,m;'4rJFFTh#MH4hkkHWlnT1?HkIim*u#t!"g4V:)oDHiAq\MS^P
-85[lr.7qt;Pqbn[1qbbAe!0ei:t*r05uH.^/Q#DGP\
-\M$Ub.K3%tBDEaL7>L[?#t0>!r_!JDq*67`(Y/,*g^!Y$6/+)mVH0>Oa_qJ\e&2tc
-:_nL'LnZef(FmLH.<7Toj\WU>PCb9O(oYhr":R8ag19f51-b)>@-!kmG!*K\F*Rmk_.om!KEJ2a8(*M+6@74O3?LVHCr-U84UU<
-6qWe$bkWst$D6CPC4DJBX>2eW4P=Gn(rVjAC_k(eenh2)J`:`H1YnjSSu;EN](SqL
-"4eRWM9@t!#Pk5t8.lM?E5Y9B)AGU08IQ%sgdrfS>\EkM4=WbSk;o/GdR97AIc%^(
-d(8DVXo)ASamf5C+3jHV+(*@frEjd%p\nN\l1f_P-b]HX?f1\Ys3LZE5SsY)i$8JV
-clN:Zf6"JnGj_M2Hk+6)WOPBJu6!U=2E!W305pe_Bl
-8:UaDr'>mI9L%5A8JNE0>_tE0i^cWY,p_QIQ'0R%9M(X0-KO6Y
-PL=nV&8:>m8"p2R"MN5E@Ee/[#fh$>NL:=IMBmuP\e!#eQFV#7-@uO'&`BoO6FhdW
-@>i'K_H@fb!1=+Jpp1G9=UY^Y/jI@;WupAD?VPgP2C?jD8Roh_])i3cB-A.E"LrE9
-;Q_m2OT-.A/hJ];KZW6E-\^P2'!G8N-pi;q:#d\f%H_Cd7^R)o0f!drRM=tc=B;pIP&IIrts`tIuRlL
-3gmB4G4+JIaot)[$51X>`"PE+-.>W1Y_U9oSd>Ms7fo]^;(&E`+6%r$
-:ZnVJCP%"e26+SsPJ9WOoo5`T5/p_5*Fru_PHrb3bZS.+A`OkhZdsTP=rTnDm3SU9
-et1ApRoO4h5p\c`l.=M=-#D5/V'"`F@Du?O1;r9q(Er4G6_J=bdnNMj%SAE%7*O\]
-E/+P"ck%Ef.raJ:s'm;OAdS0EJl#aSYnE1VNBpo5VgtlXKDmK&Q^':,NDEiYgaOT&
-eg7XUU9f`OSiu)uOG0]g]H,RchSqRBHUH5+t
-OiXd:Q-FM[e)4D0'7S[7I(caiL/24W^"oHo:=g)i^r
-SJ@mkArY3YGa+9c#b8lTru(s*950A=FtV.Q .Jj19sk6*t2NYiQbPViJFA9'[3X
-JK6?T?`]S%dAk`+\IJXt5O#N+K/l:1B_a;c&1he)[EC-]$L/78oYS]eV.T&&5W^NaZ;jh1>bp"nH\Ho:]a
-8F:PSXO.L#9@0]B552q(>o9)ld(MjdkL:h;X:i'#&_q_p
-9,4Ll2pCC+A"78^O^WMcTUO'M-KE**9%]EqbYU"4)/nn2gaa7g)X]
-">'QT:f@No(rbMibOLdWJ\`I=:A_j&IW\P/lJASA<\8$-)&i,@DL-=L0LX!.-9B@m@Fjp
-;[hZ5SjkVJTmWcSUre2+>/V=*!`Y2a\IXT7"HZCinH/pA"V;7N&CCjt&I?`[q[nr0
-&^_[5&L.oc-PD3ENiV^l,Spju,bV7ddVQ#!WNrEp#"%Bm7u@"]B.Cq5cqR=J7Y)VZ
-n$8r@L3`9e]#HS,kc2:5b0#H]&ud;YkAq;OjT!Bd'M8-KBoLSn+GV5XA&*mIi4=47
-llY2F&r%r(!k,22AIEL-)oB]/0b4jn`>k#X*7;eHn]Mpbeh>Fc*RWac&`Xp0k8ocO
-*l?o[,c8_cXr>H+)Qm-`mSnudW#(KF7q)B2^ogrOGeNU(jsE^3%8KBgf(+Ao]^J2A
-%fRDUFs$7!dW+nTMt\:V'Zt8;$d;#`EWfU#rl=K6('I1#.e8?h8e[>['l7FuTsW7A
-f`K+aXR\k0!Z<"6LE2P7*E%qHdZZ)bQRN4A-o.DE&u-pSV^dk1.a@a@71G'rY:L4(=B)uYKhtk7#A&@kX%W@
-MUO'=$BD#nhhi![%jD_g[+%_;Y=eU"D,q2r?4lJp'sO\U@62Q7*.r%u0QHP1;O]LA
-6Ssso1p]\/do/+-+#ELm2:Gnj'4Wq!B/YPMhi^<7ZM#8hR_*"2>60o$Ld6].te:B$NY]RpiH40]_]oCFhS7'oN"`a!GuT$n/W
-,r%Y*!N=W2#sjC6XGnLDB\\n+3YfRu'BSm)d8mH4h'TD$QDQJV97&$U.OCJE5%1`5&dIfc_ILSNYKEB7eDAnRRh[I#bJ?UQ2fI!$qMl791C:H6#4;F-l0H-o]6tpWQWLhiW
-2OhoX%sDF=[ob&nA5BE!'*VS!K0q5dQt
-+^iC?h/*U&+r-@deY-Y.DIE-hf@H"%/K&932ej-hC0*K=(I*"9a`BC6FOs<2(K5HX
-<\>pg@["='2e$th=rWadQ7jFi/**+W]3/p.\L;3rf7J7tb^$&M?L3-kkWXYXa_oQ#
-b'-sO.VDsc_ZD`;>_H@S2E'R$f)%?m3iQ[e1Vb"^7U`@hE#51apH
-fA_pZd=.GJIb4%<(\;%WhU5iHB"#RRp]A\ijq^^8-P%V1o[d63fe(A=]ePQ=anpZ*
-6J4YD>N0CqO3[lo`cZ3&In9(1nauX47qW6=4jfeD$]GZf&os(gbAJ(;p;obJI2f[[
-^UMsQ(ZC-.jbHrbLR0e2p&F
-;b\]OF:]l'(tc4JGEA2?OLTk'fb9Jc(-.cdOkCh>)'b;I-IGBM387lo-.M&@Z\]rR=?(E1=kSLh&t?j_;Wq-nZ$RY05n#Iu7HN?UqfZ#KgDbf%$E
-P$^S^gBhTZo;g>G_423]E3)[h7Z9U+(tY)]'p/6lO]efKRBN)_ZZK?JS(YQH)8htI
-`hY3]f[7!t:pBcSJI;1c=HQH@)<.'#H!JIKeP()*p>pn%Ii,5lnaB&B(]@nSG5ZQs
-S;AS_nar^/J?WI*QM%(FWr4\,$n3d*Qki$>_3V]/"XC8>nEl1_3'Er!4e!?_RsIeu
-RSfnb:89j?V:o:R)IoXJAo4V806Z_B#_:DW2.u8uMM^nr(U0L=Q%_WGa7Z5EDAAee
-lp:8T%h\Gd)PU#*:;8`[VMH"#9$X;Yb85`4X)?B/jm<@IN8hDsq]S.k@9c<_4(Q^V
-Pp07h3j#FH/#@PjV4-eT)XFS1mfaWmYM0#\)[!I`]"f>**XgS7Fk[4kA&nBV6q]TYBofDS!1B%Qalp^V7VYs)l'uKVn/@t
-+gtuTJ^.%'H+T*\n?GH8Zbh"nV3TUbXB8O1=bt94/tSNNHM]3.aOLXMR@in;%hr`h
-aZ*p-,C_Q3(
-71T&+\c"tGG@AjFU^/K*]M+J:l?92Q@[P>MYUJl^@`Za@&noLmd9RpD?4r#"72!Do
-OuWDWN7^7WH[Iikr6`bo4jAB'c%>9*guH[bkK]U`98FQQ9$Yj3.'<2I'QR4j7Q&OL
-NsH;N3>KblE2&([PL53'\M2hjZ4`K9DnJSdf8-E@*:0LKFZs^f'euM_%8@8sfNq:D
-q_/$GqO(s"/qPHdI/Pncgu$B4B?e,*em3.DK)=+>GLrC4fA1oqm3@S#GF^5E)5QB&
-%NJ+e[[19gEreO;5q(6m;I36@q_rfT%)',+(N+ME).>[%o>)6)Hd'0RTk@idg)1\W
-IS28$8?]A5(4&Fj65Bu;(^=AC3!1*L_e'q5C]/82*H0kAF5WVlS"9N:*Y[L=(ZCC]
-lqp%:mj"%T:GJ1^b/Xc#%WUMQHKPWp+uJJ-[P(.Nl/ZaUA`EHu0"eq7kY^H+gB
-WB-':.>^Z5]M:bZo&Qa&eY8Pd6mQaB;6(W,_-:(PjsD>2hNQlHQ/KBCl.&SnrhJab
-Vs9kRX]#T4-aPIcqSW`d]G>;Fo!k8BIhd.c%7jg=ZdtMQ+E93mk<`idYfZ;C5d"3L
-jrUV#OR]$"56qqDG]Z![XsSjC*-caXnfbRf?_cg!o^&2ecs'k+PdLPhL7DM"u?f>n?[>D>r6p5M4(J
-qS_+f:m9f$6*'qm)h4NtYOkA>rf7i0dtCp#Z2V^65MGEoZsi+^W*o+^>W*Z9M8`ro
-R+ujL#c8rJZ<9km=#$&dA[@epmVb7^ctN%I>o&o$Vq#O)RZ2Ko?`hssp01g_heBUT
-DKhS`p?R:Ci:$GG?7-hMal@EP*56VUU!2bBqL'E_?`i#HpA5lUf6>'gnTVX;+"r]"
-\]B*qT&4b,iUQ_krh!Q,hspO@IfH%toD\eU0GF`n5d3'U"@4_@(C!10F<:cT0U*pl
-6EmgM"J:Isrck5O3M_.oV>:+)'kd?*9VG!c<%oETY]>5T+HcXfJ^L91)TM/F^J6O23hfXR>ZWf5
-G@"@Yom^@O.Db_*TBDp#J"=UTrcK.qAY!G*k:r_l,">]rKb10XE',Z79Na9V+_5$f
-TB%CWJ!#::r^d;e.aGA+kP6eR8?t6J.j3kLra(\Aq3FfO7EPQ?f[`KFKOHi@(KiFM
-Oe@LS;[Htn+7gZT8-SPq7('/+3W;U)CCm%b+6ES;&f!q4_IK?rqFJ!S!OraHKGJS_A;*H.k@ApTfIW;AW2\*SI5
-f=UO!rtiB>Hp9:)o6ihnfCSsD(T[=[5F:R0I_WA\r-pr_p\oZWoDa=OnRJl5=u1jD
-rtn'T"@/mu5K2Q2Gg@L)"%RS=h;U4%8Bi#)7i%,V#lbU4W_miaZN0pN:/oNsiOWV8Tt`>N/2B8gi-1Ie=j)WPpVNY/QW7el-d:@)AL
-&`u5H\G74VoRDr8#!kd?#pEh8A;1L2,/eKL22Cte)/u[,NA4Q,"H1BI@^Im$q)'NF
-fVo7`?$*6VJm)_&s+B<9*\h&]5K+I;+QOeTLiNDMKc24T,>)4MOg\<28CnsNY!^Dn
-M&qGPaBE0E^C5da/VC;-'S0,u&+LVH="kMDjgd8U!*hb,bJd%'r(jmO8L%[miaqEu
-Hk/2IZ!n-\Se:r_:H7`)A$#ErPN$pbRJB&0o_P3op41Kc"Ec)O#GDhYKi#>u6YLTQ
-U(g(R;*$+T=b-OBaG>>*!DrA/E4?E6E&,96o#94UO/2n[*DK$7.>/&i&[PX"&+N=.
-a7urs6MQ9eGpY%3ptHUKOMB:#/k>59oQ0*YL](',XeU=Y:
-rkV\%$".R$K8k$-`E9_i@r-:KZ5,pO=Z\'DCp?PQ"-Q5Sb!?:V'($e*XL&#MY!;4U
-VQ;\G6%N]!O[oWgdt*K"Noq"l(38C`O'A9%B7@jsGZss,/-">mK,)-qF'j(lL.W
-B$/q*IqFrL<]MtpfMp%uMupAeS`"bCV&#JcumE3V?X
-0"cK?\^-%$I-AK7\8sA/=?jfuY*-^#>.hF]MlBplK;&h4#[+AU*)MN&Ji".GM7[T#
-&>3t$_0sK]r\MMAs/i9N42ZG!PB([AOX&)MNj:o/*=?d$_48(>7HKQ3$]5OhTlr'I
-0e2$>rtaSLg,[Pg7>>j&0M]>"cMX<*:i6Tc(`PTqN:ifak't^'#pDkus5?7!9$Z?HdJfPM$m#SWCjK0UR#_P!_K5^k!?E
-FfZYt"jBI"M
-]2`_FC7F0Ac4lVX@jMhdl*`0`+8%r=n;_4X@Lc(dF[19`k?u+1SaE<9L7-a(E*De'
-29,!%;U$A:asbX%^1CB6o3S@lGK0RI'k)hj
-3L0N07ZAG,^!F05]p))ZR2$RUa7sRkh>G$Uo6to0qB&5lI5h*K;O24LgIej-CN7J"
-8=llSK!##7I1tPnM;mN<_AJ
-7PWZf0%1O;UaJK^!sXmQ#9[WhA"K'.Mk,3o_6bhpC?VR!UPoktL=(R,44+5)3BS1&
-!K%?i,1\=ZOM=YUL)DX>.3*@73UNG5d^_d1W!&\)$,j'$'HaQ
-J&A47L/JaTXBHcDBot-tUf9n(o#7<'BL=:U[HLcrS-6W07B5u)\EP-H$WFi+@>&Z4
-#fs)3lDQkq?a+W>`oKKVoKgLpDT;m"`tWR16u>F^FN7@'a(0A6FEa2KIB$MBX+S!=
-4.h9>A@1sO\=6bO$ZHrf1;#*a&`GR/e00L6$:C1ZK$.$qcp'6UB<&:G#4`O#X!Air
-E[6KQ-44odKTDu\-96$e#,0C5+Fh:&A2Q^,^G-V.'$s"8/B*ifL:d=4.hJ8!O=[JS
-7jN&qoUa2.Sk9]harI(Te=B3"UrlZ5b%.BlFJk1)0W`I08LjL"WiF11^Bbr1#PqFh
-C+CKT(c^l6U4FDRacW+3:`Id]V4m=Y"X.(dZ$-F
-PX[]8b574<1aA`@RE:\-6b%0CHAftp]1OWras>-P1s=+=bY5Cfbi%PUN6f`Od*39P
-bp:`MjLdmZP=3&GbulZpH7k-ATEZl=TQkt"F"OoG#K8J;*'rDcK\r?U+hVJYQPcuj
-6F6qH[7uO"8!MItE^6?-1()gP`\`rM;UWN=+O7NU^d)q<^C`g*2&h`AMOH!$3M?4I
-3:"ShoEbd$#Z-17Z##g3\SfW$PT?3e][XSibn$H#+KqSfP&VmFUbtD6ZA9Ld`A8>_
-"7ZP&0d(KB#%DS\"Hkcn&0q\Z;<7K!o_25e*mtK>dLs:AeK`L2,go[=dUabnOs$JS
-pTKMB#'sM%X!4CNPKgEc"QM*;W.D&QCo'3120)VQ8n]Q5=<$Wb#W]Wo>(O
-O3Q)\0-&h83mf)IM^EJ*<[$V?P+RWd]%&BDT7K'ESJ/bbOJ8K#Opu-&XKI--iuFlU
-c$J>/M:Bge]J=%\emYo7j\48pF4XDd=(QL*D0:h\En?S%f;3fF[GJe8(\=2g2gl%^*+
-:7UEL#P_:#q7n:BNE2Md.hpu>M_5jA?'.aP2@5^'Ut*b-NuJOQ=ljk\oljRCT%XXG
-at9/f25AkoUtShF]6"%]+E!l_,8i1'',3(gfe:"Q4g,5FH/l84/QL&7QXem8Jn1d2k34_"EAG$J\IZ'
-TNS"18t'0mTrZl^aP%r^g)\>kQ-3F-X5&-JguZi:p!;FqKno4>11\%'1*RmA)9ust
-LBEgDe-e,Q(>?kK0)G#L!?2XX+Kl+^204e])@tJN>_C[`LjIoF(!tf'X\E)67-to.
-3piU=Q6=Gf/OOE/]kiBH=>NNuK]5R#_1sY&EaD=C>eT^`c1B`0o\VP!?UK;"*V\HF
-ptqA4hk@-S9.:p@WaF9r;kg8rYZ\*N"4G[?Kelr'&l[VoQ39:g)!,P+r@cF6_HAb%
-]AegYS#;QncX3gaQ0l159=h(M'YKuhZJ\9@cpfMS8";`qKZ.c=>G.B>>"@WNQugSV
-c41SKp#4HpiT9cAp)W,k*gs_^@O<;Y2C%3N,`lJndDK?H4b)IC>8u"[U/ceB85+U<
-YJjdQ&[G=q$$_-U+]MUfZ!:F![!jn:f%AA\Qd.pjC*d>9u;PW
-63+R/C+$+`9UD\T$Qr_4*%@i'7nT?^@u4.D#"RYg8E(+NjG$9;On[pS9]Xc!jQ94u
-n=6ko&@L_0-)ORKNJU#*_]\@%Oo2Ksko0b%\/1(n8-?XDj)Ne;:;$-?h\K#LnPeQ-
-Ph'ed\O]hY:,(?q_;1u"KE3"p.^4UHY!i>J09\A,q(6-[Cui87P5W+q*!SaFdNG92EkNg.O_XYf0MmGUD
-SjCQ8^-%sXC-TjOeoTTmp7#g5$:>88>Kb[M,&k'!Y<6+H]P`]4(kW!dZrT"(>K[T(
--EN9jQg&CQCSnZ.[^g1kI;=SNlfPqIp:n4D\q\=XU.K\UEj'4=ejVL9SbC$q[BN]2
-FC7(/,i)R9-Hh,.'1_.F6OH6,C)PV9\nhSuO=DC'3i0B.,_f=ehV>t7%GP1C=&tnY
-=H$'cI1g%=dLW4flb9stk25S"i9fgCmFL:b2WO3pjK)<7)e53>C]2X,]X"hH\P",,
-0MtI&_S&p$&^40@MJG=(PJ7k7i1OO)]RFccNht8d,[)@/eupCsT"O]3msr@E#3#&9"R['0E(:(lf)kGs#k4/en=fhS`2UVQLu'I-
-cE1XW@>5H0h0^4mV)iUK2hs)G>C6?0k$IP\*06O+YFp"E
-#'Q@4qPJYWB[S8jb0`jGab(W`lLqZ\5)&ORVsn=Jn95*-[jlF5.\ja,o&hXrpFl+=
-?VY?W)ms/rZW"MR^TiEO/Rf0P%h_2O]''u=TMTA,H"e%i]#USl*Ig81RlMs*!cnl<
-N-V%D<:s(Z@+SchM&]f[-
--^0RoE6PodB4nN%)"I0hWX>>9[&uh<^Z`KR`>OT0mDR',][h6b(,'>-Y>TR7;"ma`
-pLeWe5BD%(Gk[PMpRmgeg\pQ&-s-(k#`G?SL$d-sMbo#P>PTDQ.j$MJV#"/hqIc]%GGk:mW;;j[
-qPU@i\#]AGXSUPNqWG$XpTOH!Yko6Aq^8]H2m`BO[/3q4qe*A7GIRI)\GMW##C(9D
-k]hid?AG1`K^a;An4*.?!,745EJDNF
-L?Ngd3,jXlFU'UE#@M]OTB#o@jSi6Brb(BmGN\s\kl-q5rho&\\*NkZG)'aT#?Z'Q
-E-)=%GD@;X#EWX'Y^-KZ8VafWK6VeIpa:jT8-+Nr"98`*cj9sH6%HIoKI@<8i.*&+
-Dm[=antIVIQA;B-/Q2%W[GB4iUfK&`N(.;S\E%fr+-9$(;E6"g9dc/tAQ$'L[TtPR
-9P..u#ouAjS'@iE\^^=o5Ft\!e/BVCNC'Fmq>](?>IFdM'\m=c+S)rZ.Hb\HW(d&QM",Fa&0\DiT
-cQ/(f9&KG,VH5@9b[tp!]]OE$T?q7n>!44!9rHKUF]uIj[p?2iCj'#GVUo[oghq=?
-^#o';^Yj'U>WsMONQ:*lE]h'K2kA:YFF%4VVcU"Plum_]^?9^Rhsbl,XKP06^'d&*ZA:9VL_=CE[LUgePSu(ruH5Iot@2VN_BhioB-6q/_4V@%/
-+35''Kd"O#/<(mr&knQ:U1[oaGT3MgjCabjS5_J?,ljVML(JT!Ih8:#r'3T%+>A6V
-JOE$J+!i&:HC&/6jCsqcJ\YtD#/T/;)s;4hEh1NRgif6OAIV#S'MT:00oTBX`DRCe
-,=g0]XXQokFNlC3;\\%N:=L!>78MEU%7sLJeP/\:eJ2Xq(!Ul,
-f9P`O?e?,'KjiW"/WF8n(/:'*fo3%GBA+,\V.nYLXfZBn(:T#JeWH^5nH'*XTZH1Xf:\%VB\+(Vm3IM(O\0Ff2C#UK_/P?INQ#m\RE
-/Y;'Cg3XUqqN>MVE+-IMWSDV9f(N+/jdC!lQf]0GASFtsJ[0M>
-Ak"t1(o5jO>S%.V<&1(6k`pZ%kOAZ^BgABg6\D<$()(&L$1LoQPCX=*@uo[>A"Dcp
-XZ`0,3R=,\)c"p.<],'V[dFlZjgXZ)Np41DgWo,umi1E^^@3*A"i##H%h$5'>?e";
-nXOM_JY:[rh*7$Leo:584ch&4g7FCau029pg*D]\c[jR$TJ"-]lrb%In
-q0YOOj_2edPCb7_8VW#r*YtC/?qu365p)6NGpiD#&0LKMr]pTuq$%1ujIg7;P_,V.
->)oNVN(T`)\S?Vb#,2$>)i+F0J"C:Erd#T7TBl=qkHWflT-pW;5=b%@J5?^W5ZeHr
-i'[m&7ehHDiVl#r\GmW1_>"M6r].ucru5G;ft1+!*QRrH#nKE4&+ms8hPc)/_u)uU
-Oo?\Z)#kdR31I&>s=%n49m,/*fquu6s,DN"Y`Xbd3^0XW0n=YFA[n"
-:+/P%V%mIX=,TpZ/k)/>(?4spN"M('``U1tUEjK3;5Q6@Lts!0Hu4lUc8eBsiuR0U
-G`L265"E-]*i&peO>6`#86H6Bj;a#`
--Y%g"PZ!N>8m+k;j[?)5;Qa%mfj-,iKX$h@c<7",ZE
-rr?^q3N#LK:eCM3-`R>5W&4LI<*G,Ul5`HpeLI@o\t)c7KhSLH5,m'NWE&5k=fSlI
-XB!EN=).q^Vfe$*Ni-!!KlO7qcFQ"*qEH+$ruFI7IuY,%?YfUh
-YQOf>$Xs#jKcpC4U.BclT_q$nG\MMcGYJ;WKF8%[KECb*c;%=j$NWNmUgs=!"P@6$
-L\S1c,Q(l(1&`p2\GmI6XFH5WJGKJPH(Xc\hHS`_Dsdc0+#+1M6"/P-a8"O/RIpqGABra3;9I]s"S^c28o?sF"hn/_nOfII))/)c-ML(V:):C:N8/VW]6
-)8fQp%Un+B50(bE*Fio8NPTp*`b;'b(onA1]3$3sbI\F]*mmkO,RgWb)%f,jk^fH,
-+@(pWS/nNhOQd"ss+*>e8
-bRrnrnIXCrj-40enY.Ksrt,rm7KR#t,XHf$KOWk%O7B(t+n5LQ
-"-55"%35N>DNVc(:Bfug-)IuGQd],N:2,\NVY'kYe/FBFC0a3+j3E_9>-CtAh-I)S
-L9]<5cWY*iD6;%;!10(,rkTc<1*;J_Toa.3$*<.r`QlQX;pQ]q9^^@!r^!mZ84*E_
-s0[$aee$bcFcZ&.#tOcU]@54!9d)\bk(\bL3obC$h;,^)M!5iP15Q5*r[^j,@O[n_?)Mq")^tMg05ALT*.#VW/Y7NH*f2a8"g?
-j4oEQE^!4=\ORt-4J#/bDI(H]LG@prc^Jo]D9_ms3Na681QVLr@)g!kG%-m05"co,
-"%1iNI4M0%:6m4mrLh3h95B+!K^f2\4b`T5b4W%=-c0!c'`i9'M\+Q!B"R*3n#u;D
-ru30CIuL']2+.W,%"3LL&+MCd*mSu#s"35*pR:`J42rB%DA\8(_9tN_YN\(]-03c^
-lio0D*5b-#m\u>7]s$]!?a!NAN[7B4aP.MMiZ/DGnZsS">0h/^N=YP)"sNsZVgK5p
-c6)"qi?=p1.gFC>f_05[o^F!qcm8_^-NYtN!q7cD0Im6E0a!Loj=hMU0LZ+`8Hc7l
-"Ro7l0N@1kG2eG8+$o8Q/UZ2A2#_8uHf4,Ei1Qh1ZCJ.HaD&luMa$WiYab'd+5p85
-@=#ooL_8VG$*^$._4InT_S&8!*KX>10XV:(GaV3fmjY-Z/EV;[[X,uu@)u"BmJO=`
-/I"0h:tnFZn1q%#1V%rhIY0`_i)rt)F<^p*2<0bk:?)%j+o
-&b."W0dKidL8HN)kMa>s.!CB>U_QO/[NThh0=9ToU7M\P&LlB.nkS&t/6^=l-M]9iUQE^bkBI8j
-:CZW%r'@(9c6/f2G8RGf&FmRJOi%aX`>l/)*:_&i1!L_9d2d$<)q!Uc1$'HrkoR+s
-*qAa;OKTT2#dD..f[3$0+NY=QG^$tThdIYS/dAXUKb\=I&aM-jDhQoL(@eNT*.aK\
-9)*gkSKjidRAl4b&b@8g8L1-M]ts"B"6?YdeA\A&+5om$&+XuSGfU3("0SF4TQ$A,
-[!(rsYYnO4Z:r0@fdO,]*O:eUdZZ*MPps#,.IrfT00(G$W@G3U.e9hp1:8WQ\2C7/
-+34N8;T11:nD]=@#)IN#.O5JJ"X]@5%8I!21?0uBD(_uj+cq^!O+nJP&CA6sd5'#u
-ZNW%(#W=F2YYn_\m[Y7ok7(#*HBCmj&$GA_i#L.Mb=_2pa;lt8I4l7dGS!ZT
-'J8m&:9&VJ.,2$?gag%m;kT]kpEEGU021@9O1HFlW"nXG'1^q91MJsmaXY\i*C7!>
-Tmju/?SPt9]'lG@;J[IQVOIri(Mb'0C*FUJI"LQ;kH66rWmN\&;a@Zd5kG@K'Fd>b
-)*r?b5trjp<$akQ.71Bn6M*!"-T]jU(u^&G3&EiZ<'`nas#>Q2+7KQoNXQT:P9s]^
-"qo^;mg=:Ls$"qK'h_@3UD'L=ED#]K-lOg&r+I/V1m4MR)aY7^9_9E$'[9?/fhHSE9i9S;FQH8>
-kt\VQ:A"'C;_n)(5StXYi9h6:'`bfQV##q\gQ9f0di/`H3-jup#gUSeP:9CFSesa3
-V."!]62rL[a"o;i)mo392+6l<^4FCe$FAB>iCXHYs$dT"K]*!&i>-])/LOsllnSV]
-:O*d77[>mi9soIFomp4fKika8=S7MR$g1U!R9?qg=nSIl25K67.2_Nu4UN,Q/^bR(
-Sqeg7Z1N/_F0Re-5eIX,SI73ZD?^^]\F:Y%)M('9pS/nYfjf0(:h4`":
-Ntq0;B_EM_%]k;.s"7@IqMfqC[=208+@gg4;tQ=
-)!AsV&+1.0]j17VHIJ;om]BN.V](>4+5qY[l(jc5FWZcJ,V2ud91DuVHPC$H&o=):
->-s2](5br1QE+NADMV9/Q\g+'f6!@qqbsM7Eqb-0.b?I3cPSL.'/Vp8cad?G_.$gQ
-S5iuu9u.tkjl1"F5
-E7$I[I[DjB.bQU,O%HW2`QXTJmgWQgQk>=ncjAZFc1:5O"r[u.(T6%./K6J]8V9Ha
-I@&E<3,s^teVCYWLY-ll(i>(RM28[$M"m))8eYU5P.>V^MS<"agg*M_.cWQFED):E.Ja)*Y`?_(<=<:["2`3Jsc:If7CFf\ViN!W<8-\ds'[gkb`rt5j#75?pp$'4?MLuCI"'=B!KGSka"5#=(OH[!:5duZnhYL9;s*IS;l+\C1%`ca^L11+K)e+1V
-AG_Ta8.mn1mWt8jK"]]#Z^ZNU,C?$&pQOROr#qTCoQdkQ7X@?'lA`&dJM,i%E4(mh
-$>Tk/]7_ro-bHu@]DF%i42&:2_)'iT]_g*i44V#b8saA%2XQ*Eni<=>qa\4bYAKh9
-1)c[ed2EPhqH-U)@m!^tAqdiL64$%cPTn]pp7_,D-#WnD9:A-85;t&,,LU
-D#\CH)R^>%iLnI'*.Dk3\$lIG>K=^0bJh*8`V`lY**k%A--!T7`r'hs04+'u8%JXU5n2)/jF3\QG?E3nWiipW$OPbMu9`
-qC]!sa_3dk_t3*]NsUB-52;Yq`,!`5>7ess3Q=2K`dIkQD?pWkAObT-`24U'2\
-#g:H">7Yp;EaBJ"7qgB/)GRt\Or5l7QJcYm%FP:qNR)+(kp)9,fKDKK98\SU).0d0R,DnYSb3G0npSe"
-O0KLg:5*IqE
-WSsGLiZ>Airj?bFII"V\li+`e,@6c32#I05]\_$?n%$i,VkQ,L>k_I?CGq]m(_c@r
-'ObG[DThKTo/Mqnj@i8;g=sHcP*pN0XrbRP44PTVXQR9#kac%7S3L^l>'Y6pWnOBe
-m0hN)\ZS-*lTVHC5=+pk5P27TnR#/d5?7B)"ki-ff=,L^rS9]pSetlUZ*UeR?ZS:p
-ADYkZn5U>8%Aq2!?W#If,!fZ+?Ylu?(pSRXd*3+ATq9ZH=o,f4p1jiiEG-'nlT&#,
-ZRAm%gRd0?PrV]O`$)I=WY640JAa&hQruNChb!HIjo3$Zrr;-_?`j?Xq>\5-+:n5]
-%LE;k6/`BB<%]$tLI:&5(mIcE'oPN@&X_'c3?=$khCnVML&U4J^Y?s[qcRJ0AuM?g
-1irV5GCQX:0D-bpFZc50e-+D":i-/"#N+_VPPl1>J#%fpo[*jAUFAp]:\CF'rkLod
-fnoJ#@;Ps\/o9*s48m1AJ%M3]pX@t^Fh:rJ(RrtCq0g"bn/*,\%gds-@IY2)<\G>M
-a(+ZX*0sALFc\iDD5[8ZM#V.g?gJJ2rF0PlW/:!8W8n'm4_8uY&]3k#nX8Vnnb4GHM*g]Y,VC&:Rh2]6_\_HRr]H,l?J&UO?H2N,`
-2lk?lpNq?1c^2E0nbR\5hk.+@nbi>MYQOn+5L:YX!l/b3'*LU?4<"Gict"4)6852Y
-$USgF.h"dae2n)VnDlkG6norW'1>\c9,,>7;u5cJnUtBi7WG5>)b0A9EudbjjEht=
-ncXRg89,u6,=qAnP9ie@A=Fr^r-:RJpD#a8&I^+6;pQJ!0p'
-r^hiWq&gKuZ[CPXOhk3"7"bg@"q+3_g7Wq[/P0>-+6E;,J!n7nrb`Omq8?g9k;fDh
-SYkd$Dc5*'W.1E%Jc:*?Eg9!h<-9K[;cNEY;cQh?AO:g;-i*+Q3,U;lZPQ2Q6@Y>T
-$3!j1o4V8CLa?/'L-f4Eib?8n_>HX:p0l[3&`ebaaOpZ;L+?oTJmhju\W6q$'3KA9fLo`jr6`6!']S?<^MaDG-:C*d!)^/?>R<
-r`4uXP,La#Vtg:$kZSFQ5QU.@,@ajZ(b1#sJA%.XO^TNV,bO1[h(=d_)/aqpL?;48
-CjRMPZY]M.e$VdQdHt*_WB$t\>(arr9o++]T0:j'=oYKM@B'6$Ls7/<@M0I*H?'m[
-&]D44R6gb#D1&3*LLGSN0?mpqk;1ETI.p"TFF=*]d<+1l:XsSNB2R9'I=GINo"Cr:
-gNNP9F5;%gkBl*1rWe)7G^^tiEa27c/p!I\LRI9"XP5eA+6J,NJ!bnHBKRBu:r+n\
-`/%j"K,QDdU1pW87]379SGq$l>/ms:X:#WFY?T'G2<+XckPP9Dp]1A#o.)f^]XWtY
-Xu$;9rthC8S!/t"'+If-DrN_k&+Lj5doepBD!3U7nT5iXpra>'r,.Gf%'3HsauP5<
-!CHB-m%KWJL5s+i6TAun@Dk6_;"bmHpj!DooKe:q%O4@iOFa*Y98Sch-Uda''Om;*
-MNLpi7
-+]SUeE2ZH><2.3mBF5EYGS/l)sbF'#!APCdN1ZjqIRZg3UbqqdAVUX@iPBLk=q8#%'']Y^IQ?*p6,X:Hb
-.$9.DB"^K*TbKJW4lIq%A"2Uoborj`3W23V!lHo*r(i!>r[bsCrtu2TD2Z;d
-39NF_5Pm"f2PCOCMf'7[T:u5>C1"#D7-sa'/nCqqgi^('uRPJ(?8YHO`Eu8p`;n4
-bmi'NocC@nX>A]rb:.*NAW>D$=)M-<6Xg;!)h5$`l1eS-V]TFFL)FHFIuR<8$)'_E
-\^0>Y1E2U.Dq4a"Qh7tP_=TtQbA\Q`CgG4t8hONcnQJQ(u8W#5\.E.[X(LjISMd9@,`gG?s@si9VERm4lR.SF$
-;8P'0EA53slH^j@cldk6I48+`-KNPSCa]*JZ\86]X^QMui+?091>5u=$j8Rn@/+;j
-_,$T?b/uI4CX&9V2bl8.RE*D@OS*fLelhS$$b7VM`@Ui^L&SS:+oHOgPGcdFnB*7eCR)RUK;$o.h%egtE8)@e2
-Wfp(or@t/D(BEB@#D-oD%Dm?C$`@5'LN*59`-@U^iga(e5[@#n@Wk&`2Yf2[/FF^4Vl@o4hQZ8!rPbHs<4ardiEnr976_T:ALZ
-)7cAlG9?C`@q;hP>D-j\]7Q?pA6nIm8,2Aeb&a7%NY0/g=(1HdO0a!^dFikBBC0!*
-YP.tSgj>B/m[_tA4/7W=Y)(77XjEZ(rIl6#@`hK7kh'[IMVekFrtPQNIuCQ1U!ue?
-+61Rf.hUZomVJ3\NOhc$\UQZ1T6Kq!Qd^8$)Y)KcQKJI%UtomDpuirN:JbKiF_a1D
-:%mT0I\@bThV%CF?c2X\'B+=GOn&EP`eN@IkC!<'oR<.UqO^N)k;uL$aUodDIrFdu
-bj4?pR&t]&+BjOq6(V6VIJn<+VTS=te!$'PIA2BB=0kS%Yf7UIq;o6,(
-gEi#j"X'k_E.>`T;`S!^]m+&j_`J(M>Tc>9RgK4p9H(eW0gclu\gf>1F#u/CV5&!"
-Q4^&7apTM?*=XtV*%=34?tVB=atOej$ksIC9L$?u5XZSX6nCUA4@2G%bX:_d6u5@]
-Hq6Ya8Jo>F3nk/niG4+J9Z5Rn`6g6TLajKN?]&6h"?Q'8+nROIE/2aepmn#7[*9\oJ7nLf$O<=T`nuL(HhU!3iO)BV)OsLPmlW>`;4t
-N?Z#n%J$WUJpI3`oGdW9Ka^"riWfqOYD1`>LSO5^@@/i5NQ2`P
-7dQa=m%?r2Th50UapQbAgn[P9V+P!i8o&mDJ9WK)r'JhV,`E<4P?Z[L7)c#P_d3TUHMr
-=uI3@*fhWik8ZK(IU5R'jh!mY@R\Tk'_:,g8k;bt9P49[(f+gs8\'7E`?l
-9e=af4Od(tM8gBr$!e.83CYbKU1d9`4c^'`64Xr(l,H:[%/jXT20,!Djd<:apK]]/i]-e0X\&
-X=/?I]E4m&/il8F/(m4e3B>;/%C'
-A>kotm_!k,^U,<%F7kNT3P(lXYaWXc5d%P+M59d3YJ\^Or,U-.,u%cdK!i1'Jp&/9>^SR`Vi_8,uI`lGuouO=+u!&R/'dBI956R=7(K!
-SEl2;bFgElWImNlH3M)VQ'S-2fN;2W3p]9[fu@4);9>J.b4-o3,Yb7'9o:aKPDm0Y
-J(Yj*=X]#he&C0@IAebr!mm&[b+mQT]@YF]_6ue8$G:I3X
-,/%&.^K%AV'uBf=m-*/_\QbUibK9YdTNAlVJ%n.4(3+"$Pd([F;+?)<-sGms5]EaX
-n3"&(`-nB8IAC,%V-K#&>b0%t-+[@+c!9)M>j>_2k\m3nO;Z!<;6fi-=ZJ,=eJ#&)
-)?IQ=;lY]8+^LL%d4BW#ZcXB-n4]>=7mI4AonD=-6.E17Q4nN)Uoj:j_1HWr,A7<&$
-9XH?5Q.]K9J4i8!g=??iRUJ@l,P@gpc:?f]$+3/6g$IWXL8s5che!+$I-RM9r$*`j
-"^%kVaetSdJN5`b2@I:=MY=hC9YCNag&r;N-59f.'jiR-iFWh`C2Dg_).B*T@BLO]
-]/-N<7'EAR;4\>kQs$t9_4PK3)s%OA+@`2+`QKL]);C2%XjP),.2q\mQ,%Ht45Sr1
-/RmLX)1npp&7eY-AW";[Ja#)?'X8Q%YQVs%?m(oKHijf#b.P=96)GK-IQV%^4_)2h
-j3Bh#FtR;86"D$'A13BSJjcpKqS1BZK50_q,M:rGpI7fnRN>*rhDS!N^,Y5E1B]'W[Qe@6
-537I"5VK-,%2HMZrHBji1nUH"WX<)2-SU*'9g@3AP$>17;V!$n00[>Fs[_N8r'k
-j@Z"-'0lb3k\amDIUm,PLM2prkGF/N^5QaLeKhAEYIs6Jg.nI+O;@-11B;2+i0W7D
-Kba,c"Nu$SEM?cr3j.L*l)K.cCLfmr=UBnPh&6sYWG&`B5$u)8M<`rRC?CCgri^)EASNj'CG)r/4@^MBF;0t>#,Ca)
-E@a=!HG@rZ_O-u=O_:_Z;8Q4\_i(BcBUbU_@f!c=VeA\I`OPN
-PY977
-4-K^0pgf'&+RRtQi%80[bEC=pI\V2`5Y?>MR6t(DD]\Lg'&RSUol"11DeeAZAV-^Lr*9W3^!ZZDkhPXJ
-S;I4R5`6taP42["2d#?&,=>R'VRZ+j\-D_n,Yd[pG6i/G:`2Y&Zn?_sFK>WI%]lqM
-ZhAM\q*,$&Ib@^=_W@>XI@dd@SNF:PD_Dmp58S=#(ibten6Oni`s49'g'JH]BY&l0'kbQ+&7XPqO1K(%Km.EpEZc,L!qU
-OUG9'06Q@B#rB"@2t6<(.s)'"k.;D/L-i[jgWhJeR7c7G54N8'EIU2omm(lj5kFd?
-Eq_qC5=BTc(Sj[>9D$"s/0^SU#4b^0a:Z..\R[IEI[WYNBlJRY=K[P\HldY$4Spm%
-Y>d1cKTuWsFB;OdHJb,Vj2@u!Spha3e5/gm5CdV6W#.l?!(`!+Y2tZuRC`5r;es&o
-6?Z^%p2<6?IqEHq=E^Zr7TG9O9m0$E'Y5o^[9-l'HK,pX,@V,SV%(KY3F6nT
-FSA>M*hCQ1HrYi[p:kru])<&Ob)R('Ye;nJBM(ej^P#b_3c^AEQVWIZ?)[U(MbC2*
-j3430/\21#poe=T[qL$$NET9?i'[HYPLC1PK5c.]:icdRD&e#H0i'#olQ.s,Eqf>
-5s;N)Ueod.X%a\WCjVS]_BnfJ`YoU1?"Wt8`I(j,Vce&m$;8`L6O"a=,p^?,Fg//V
-2u0HC"`Q7@)nu#+9$`j,qZkSs+4L*7eGWZMr+FW0J(SqG8rUH8Wl'e55t0sX4,kdQ
-IH&@pVLV*72tpM"6]^7M]$<+XQg&(pWtd_>lniQr;@
->P4s&lFYuZKr^XiHb?3=\JoUHrE%KuJ+nGRepitVI]rWu^\hta7Wq4&I`;qT!s&u5
->+K$c_^#+L;LbSMOP"q@rgP(GdR,DY,XDAp"5i=9'E'C?J#E[XU5YgGW\?^]bQLT;
-QCWN5(!lU=rVkqm^YS<*qr-];U/>URH:90G9;YX%eG=kgV,OBoC=RXLB!kjG=)6@`
-"bt!+Z<;"pHUXg^CURGaf)(0@j`A"=DV'6Sk4O)8?Z4Qo"Yo+HnWL+i0QEW1V!AY85X;uKm2J$2[ep1f>%3cm5$ml*uHA[C)r<5d]:IaYH8Kc%?8s"::^\p`+dH!I=ZA$4$B?3?R@mmk;m@!WHMikP;,[
--Y_i'EM)EVd!qXbC4^^QkL&^IT;Ua[50q^V!C5"2*=5'Ze3+C3d8XBh6D'%_l@5C\
->7/9:KmEZ*O_=Jr1`tfBN.6su+ukVpJ@YYI"6]T4PnqFqP"_M1flhk9L?0@Z_N8jY
-?GVp*H!j_)%>eNGeeO('Q(_pGeuc2l>?8GHCtk9Qa^&.Q*Q`?W
-f0.N'h,dn8G2:buiHX3\S`tI>VqLWjT')(Z8kl_$E7VF66W@A'9SgWDLe.;2.E\rn
-*E'4d79(L%KQp[MP$t'`98A;u:+[RL_")uC"Mt(L'A6,^Poo/!B1h&_jmAN!ftMHr
-k?6YeT'+f+JIO;Gq9!=s[)%Db8#Q/<+/A',$k:>ZU&I?0\CNW;$>:RGJ!hS1E*uE'
-3W=@Go==4;T?$YXRp6`siOA5Up?B*T]:SE&mi1-P^@,;"q7lE(%gg$jg`I'Dg,j3j
-`pqi6+is4ZT..qRgqPSfo3C#BZX=%6_IR6>VG^54qG'PDQ,>?VXWQWNK.@,L`heK7
-d]!9S@`S9q*@.UE<\UAjq?4d$BrZ&h(ao-n@X4PhR_m=),k!keT"hPsqd/0jmebl@
-^pY=4U3pqDRPCmHFS\p*L5;r'RG?:X.R]FFg?-)QGt7\WCA
-5Ze[#i)C/:O?Nia(``aPKG/sa0$_dP\j.'kD#au.;\2,C@Um$ti8k_fZ1F;,3SWf4c
-:!+>:.&?tHOn,)C8sr[/j^bKYd_8gV).Z]N=T9IQiCKk'jIIUH\kWD'TLCTHfS3e+
-0u6`D@XUsu!#;OUTXl")H3:^#E@&[:I'4Z'%R
-L74*QCd5pYU`\V.8<<:_+&q6k'Tk!".`?q+8N,m:EE,bMksMZ2Q[00[4^jf[O,L9J:/PmAd>_Iuj+>$Dtmu"&TPB0j3uq6KnFb
-6+Z5b$_E`@pr=#mNk,YHr]3NQs.JEMG`HIog+@I/][rbI?CTIN,]Q//&^!.)AsFDB
-pmqdN$K
-I9^qF80-?MW`mBD+G/VBsC6PU[OM^5fg)27HjIB$_u_DWo<^
-b+_,e,fuHu:F.c?OK@M>gXi_[rJmmj0!rpCf\7KYCn+"eM>7*?[pnZ/5u&19GX.`q
-oKX^"$BrD4%2'/p;8f_[+#BIo(U'GIi
-X@N8`F=%]93Utla#QH=9]WcXo60t-uf*1d&<#jeI9VebTE7XqachYnhh$S:NlX
-MG7U#7H"X5$B<"oc:6Y0]m:bhkkum*??F!8NibK(L(]md::,`]G,8+?)cWHH,uodH
-/gf4QWgR>mY72R72uRQOCos9/pWLt>H\]l5s$,Xo&"W?AVpkM"8d'HY[J'U_h>?)Z
-n03l'b\l27*5b%4rf>@g*>$o_6V(3WnTH$2(nr<7#pQVkMpn&rhpu4"$"cG5766h&
-$J/_%lbV9oW7[*U_ZA++!Y?RX6Lae>p:LZ7]8h^2_0Gs18d_:8,X?2"l\*g)+CcTJ
-+egG$!4F#']GQ2BY3ljZ:(GU.>l(Y/#4Q[0n9"sIG6cKA#S;7.YU9^5B@>%A)@'*^Z)$\fneN"N#b&n3O..@_,GRWT$H
-*H&ZZkdnF2Ka7-"#VdtG;)8lJ0b_qn'B\6`O[g+J9,,cL'a``_YE\i.plWZ=&hZe6
-"O)UX]_E(R\h!%P"rLf%SI>i'(^[#U#B\36#YFDc+Udb5C)A/__;5W6E
-k_eb\Ku]^NWPjWbR$kc/e];*c7c4!(Zi
-*msR$&bcP#W?9Of+;+c!;?gILC@K4B""E@SiP]h7d]m>)L=+M]M3>ET-57So+7:PG
-Oi.hWN(W:!,Q^GFTQ_2()\QOcY1oQP%Q,)CF720!m"K(/NtO6
-b&m_o%B?KA`.AR(P,X!6YO/nWnTG[UhP]jO$:2IQd:1R\fR/hA*qHWZ;RIU0[k#n=
-//#KE9JImbb:M)f/J?Ma6M?_ArZ"gC-)$hC9<,S_?qZBe'Ypm&@4;=Wq'.R^,OC5$
-b^s=qG1NaW0ab5ob(MM_7T:;jTM-!;TGI-)#q`jN.gK)%\Jma0%Kc:r*sb4CSLE<"&oFO#2TP2a!&9]*mPZ
-c][as)]fZ^4qls?;s%BMCDCpEY);Q_TdCl?9UmoA&^=T8EQoJ8,S.lc$36Bj2kd_.i/4%%L^6khu9.3*EUgD^^rQtrqX6$+joP9f*L
-19R#R-7YY1R)k?d\-R$s65^Xn)TF8BkeX/f/rU^b@m;<\6r]@A<0p11%09,,4VF5K
-ZLl5b_OC#5o!1+Ob-^IdUG<4j!GZ);C=>OlbS8lcV#Ed8T5c*o'a^==S:-K!JjG.?k$kJaGue],c&MH>r<<5
-OU`);okdd]$WjbI=;DKVee;JX(-iVh@MU1t<[V@.rj!#G]EbE3%hE0$f!\8e:JF0;
-oN:\r5au@2T6499elHs4r@c&(8Beg0a#p0K'l);=CA&Z`2RdH;])*7iC_jp)hNm"$90PeV@BDW0_FC9SmQLA;m19:.hF+o`HtLlupQl
-d\1X60[<((cI^60t8#Bp;Y^T
-H+)OGFInB6=TZb,[M(B=\$p^N]*U-T`N7Nj=HuJ
-Q-j^*>BP-sIb41@(\`CQqP0CjJ/AB==9elNoZkXq]MtK(Yk/jtTeXPY4BNhUl'0I"
-ZCfE%aHQ`ucqYed/0p(@(mEjJ='8h=B>OU%fL@MPCQh?2;Ru*N)M0Pb3pfWKAX,>Q4dg3>`
--haVk^N^DgaTq9)=N5dV=B2L`a9nMQNNSj7J0k!+kk^;X>[h,Tn82Raj`53B>O!UL:ldD_JO=Z=S;i0/'
-MA\XC=[SFA6'TGNO;Uu^=]^lGgq2OT(W']0Q_J">]aQFg,H:6CVCQQ4Ng`^&o("+D
-$-,)+Io5^aO#RZ<8E#*XngJ8sM&BNd=f7^Hc@@J=!moY7UC].SFWF@;5aZU0Un/2D
-03,hh@5i_7Z*L6/oZq(kQ!$VAq+I;^l^jO5Sp0pt\bD_aqk(p3q,&SkpT'sCY,3e?
-A'pa%osbdQm3KmX0@7:=qBjbXR[X]]s2^?I;\p5.Qupb\-aFIsGRpGC9;L9:]^$[]
-AE/_-^)/&''[-VY[0WBRpSO&cBni0&D+Y[U)`HhhBPd?tpI^Bim@QG!W>Y6*3fg7;
-qkY4'WZ%Y47F8IUF])8hWt'l6EL;jKG(1;jeuO>9XO@R+#ib-4Fj'$:B26ZPFU[J=
-L)II]1`hP^jf3XqY8Zu&aW1H2WaJ,i't$OdGhU_[>Hl%t7!#mJ4G`iE9-&C
-K_ULpQa5>7WLG]Lq_b\r@BWm"Zl;B>6p./Xar:RV-@'11:._R5C(g)/IDoA%BBVpE
-R1("WQR\2?_0?M=8mlTnMK%F'pkC<0Bd2ndtt^$7\iS*.MTlb:6$V&_'%"rPg)1/5_1Eg:^O_!")&M_AnS-iW)(,iHbLJL
-]tAp:gk*Fk7EF8FaVq'sjP7rAU;db:G>W9!:Dq<.\#_$nh@5U*e6`$ik):<.mc+P@M>pk>\LESsa8BD?a%EEL`(1X7jB`19JekT\c,n)\A
-!12$^9F/aD4P\3/<#.Bh0J/?V.G!,h-c
-qIp*BCGcoS^,'i+SIa-HX3ob,dClm?h6].)F5,Ncg_!/@h0No"L5SZ5Qi5?-.Un<*
-L3(KRetT*n.j1O(%$t%r;Gp^^'t88#73`B\$nj)>#NYGkN_,X[[W5#If]@=+)ql.@
-+]'cG4t#?].U@i4:K."*<+3C1W2Ya(l-&s92WJI\'&>LO>fmt;]t*6q\)lGNjo/JK
-hC[l]CZ`q254-m@1r!n:"rV-7P,>m:rdl#"=)`/ID/\#UZ/;L3T*!a1bNJWK"pqDi
-WN6I8$R//"F:L*:3dsbZ"V5mp=jTfp]Qg]ie2:gWhUENd-KWW(k5OE/?KO]FPnlR6
-1#4fE:dKN[=Nr+YM)>=m@>Y[m';8\>.d.&u?Phih)s/4anX9(uOg^XC#dqM_76f>"=8HT^s$MQKkQ#u.!YKpTJonMS$D.kqKj^Tuq@kdd7>W,Ni_05Z
-D1Afg:\MZ]rp+F9m?ZLL^>X(B>jdq_[GLG!]jC/og\(RIJ\ba`Qs;Nk&W+J9nX/*T
-59Z02AFc-n[U1bWc"?R8h"H4`U![QGRU%hD;5r)\opX][!SZ@iXrm"@U]"_@J#>j+
-oLOS#9r,Y`kb0#=O^PFK&f,&brRfnk9:q9Cqt9iim:6pLeMh]ehXGdf?=+58alr>B
-I@e2tX5WI@qu0r0Vr-\5qgQ:%^[q=&5EHQY!PgB7%g,*O//JFTOAm/)61C*Z$:6GJ
--OW9q`&A(AYgbfG6h(jX&k!
-+rZ2t5`u%69dF[WJ!/dLr_n`Qq/AQjk#"C5(,E.HJ"4N8rbn0:q6!mCk'9XMR"Tba
->E9$b="oi`8KnuoTYd^YOb#7d8VWG-G>m$A!WGoPkP8"/2\"/`6QbGn4L6UE.@u$\
-7m*VU=>gnL@T^&rO(;BO;>7W@M+1DIAiZ/h`h17T,t[8pR5=XY2];`s'8:&BJm*?XAcW.1(b(A#6.9*!XhP\djk2O-nMYEds'KVLa/VC#%(]kli6)ZP'`^#k4j)A<8n_cCaHmaUZVA2G-=USY[
-08:%X)'e\,3!]64(Ilp/M^$(eNTn2+YX!pCf3U_k&pG&kEG^d,ato'gfk//$.))Uo
-'jgN6Ha.057B!I,iq-N8&TTTppr=4],\N(`VD?/u)[tbKDiPFL3Cc'n*FlI#NtLHm
-P!T(/7gT,78fV4FA^D1u-l[Za-3-TGs!(oRN_JGPX?]o6gPS9h&>3T2W\Gh/e#RUk
-E;4p?V.)'pnlZXdr+_,b<@]A#2]!a`BbCJ9*i66QQP/Fd9=]=$Ab<`bK?SHd<=\Jj
-nn`>DD[alZ1@[b6u7i]Somer
-ffCL&l^dXUGY^?]4_K`JSs//\,)Lk8BCu4s'F'+b3XJ)c1ZoeJQu7X+!
-9pP5R-DY10Ojm]qL^'.gho^!^i`$kY,j@gn$!Jj2@G;,cXLc;'rt^f-;a[9q:'V?O
-+60#/e!bJUMb)PDj3>RSOm>6m!).RK*O0TNja]U\S$0gs-'k@/IL_X6fKW,^uA0-_-Rn6'lA.WHf
-%ZXG-)C,?1G&IHALl>1TUP0l:O96gnNU#jp?_+o[<#4'G/\dNKOFi724]kIu@.cUeYV_+6/GphU``>B.Qu%GQ0C)m)a`u
-2Iju,QS`M*9THKSTD5`cPbn/,LO/t"mcIQMNUa@WkKTSIM^BIQAo=a
-^f&X+RKs,UYmd6:4hD:]h,2G2Q,(DVc?)?X'LLV_l(CT
-5q+9l2?cH]'4D7qh1oVTTTp[r@WWg+H]udg/2Wrm8Vfbg5Zp>k+(>"F.R[&3V@m]>mI'F5)Cp_G=Um<
--`(q!RF?J+:[/rjWHCD(eU"]+lQ'W?FhYEiITHe6)ITH$1P8H-uRqU"u02Ei#Jo,/a2G7L=k
-gO-Jso,_PhH+uB&I.s9**f&-h5=t*f2lHqtm_ML^//0Fe?O7"Gns"\:A'Qt6FOah4]/6o79L6q"sm7Dr_+`,nMf
-KLj%G8]7Ds`3`1U`(\,!9u>h3#?1@%&9imPD$PT0L3Rrt\6k#QB8(SV"s?VF\6&j&
-kWY/#6eDs*o!(Q_]7DYaKWlMQaAE#7=G)EUL%%PnLfB.cCBaKX#68JNQug4+Y!QqO
-7^OJ]`+m<9CW=kA`oM'Xgi1:*ECU.Oa#%hW6ukdsF2qO-a(0D7FEkiBH,kSa8!J>?
-`"C"Yd!u7J_R+g6"G""@IE3[ca>AOj6mok`B*E7$Km5PjQl*`n&VokW6]8duOoIeM
->_'>5KKp)98/2BF8>ltgn.1<,9EGUjK*Zf-
-a?i">;?r"oL*1[F89.;?I)iV&b@J*&]XZ.,\P%UdbI"k(`4AUk]?B!BbN-F]oYAZ:
-_9<&!9GDV@gTX3_`QVl4b]LnLJX%lj@(BbY'hCe"RK5stc(o=;KNeriW#QU=-&;8&
-"=Yi)q_(X%e]hXUc#hR^JmX;CP*_Tc0bW+P'-bZ:3"nr1#\lm;kc]\cqh>`l'Op;5
-$-&K^;4052\bhuDFQh#'l-=\AcBRWiV!H==fZrRGcLgSO"Rr8'ROYn(L!oSs3OBo,
-d)aGV+:+j6@G@6t>Q`&sL2^"a@9toUnPA6Fch.7a"TXiZI0[:G$Wq;ILhEj#GDGrq
-"&X.V<7%U2PFI2dK\.HN]]-1`/@*oPP,fUk4RGng&^J?.d1m9!Q5'oJ_M/8PLTQYfK_Qi#\?+#!+c&soL\OV&)@J'0Gna.p\5aJGKdbB7
-.FP%BMkTpOk^"T^fVO3)U``hrW)8/1,8U^;TFocpJ5!>+="/P,#,kW>_giUn("%.b
-;mdCi]fOW]4k%qFe&u].[6W4V6.@2Ie1e@eW0%5L\_+;tXbRKkJu%B3(jBeu@ZZD/@eRD:[fd
-[mAA$I4d(g.A41E1l@AD1IFrScAGM`"DEAiWOfQ`B<-cYfq=SG/d(KnK[SXO+F=?=C"BtXf!URiSWHtH
-OP(qBfekrq"dI\?Q.]`7W$M>g,.fR-[BCcA1*DC/,kb3R2Mu>,S"\?\*
-\2/e@Fem_kV:oLXSAH\ZgP])f\6(mt;ZMa))0=4\E`LcP#P^n+2-ZQk0sMk-"f`1?
--&u+C[Fm.?=Zs4JKt#g%[p,Udg3($^`OssU]q"+WX(o,kkZ!bm:7;QPPnL8\&\)(C
-1k\FWZm-'bSKjTAoWjiF-u0LI/\YK?c.qF+h!la9M8_4EA0sQFgp,BC-l*JIr3qfd
-Urt(f\Pr`00[6p-Z#GiXg!DI,rR,s>gRYk/Xl%tMi8,d'4$/hEYpof@.f?u@.\It!%6#NoIg]n1@(TC`+rJ_+SQ'MU7
-@(#"P^#\,&%,g7V@.b=C[LhC5&`G&LMk[/8rC,&UQA3Abcqq!-C73LN)5+Y6ZF'K`
-4r/qN5,)L61$tso/e_\0+lXgmfi&p@8eN:$EZ*BeL0I9UTWX:=W>\XcKJ9LMJDH5V
-Sqm2Q'sV!Jg(E*/G[!fni3!UKmLA2G2<.^qj%_Pn@r('^3THttj0b2\D5+RcFZ*?>
-bt)Of$!ZEg6*"uU?f6%*gR#@%eRQ<_jE=&SKdbZ?/dE5)POM<(4'i0k/!U/:)N[JF
-:eVP7Pa%lJ#$$SP,%=r6UTP2uP#aPPFu\TL=QQD^A[Yb'\`[L`?013Tjn/O)"dn@T
-J)ikEhOOdQVIV>^FBC.N2LB,Bh#6@6C$):-k-L`4!Gg-AD'b!HWn:A,-*_"s9f;oH
-#Ph+?pkuB_=9D7FTKY\t'&?Y2#r.09ji2Z/Y'ag+IHT11kK\RE%Vt8DJ`nG4[jifP
-gOdkrE4#CaU]-$UH9^P7/M"/ZceX"_2N6kNNTfB`[;)FA^jk,.ClP9E"kAL_RpfLr
-;eIdQN]kFca@f5=:mY4HL\PS;As"q4B4;/mkN7;-p7LUcT^!ksC,Oo4m\K,KVm.;3.jAj6ThR];QPXp0gs
-k+V'(U?e,Vl__;[T"N?lWU&]\lh8*[#/KR@_<`IuB`j]l:b"gk\[OJ-"\md9k82+eo2]5n1PRILDTKI(N!LcEOQnW`uOX$*V&;6n`eCI
-rS%OU5qSj8c+uIX'7%j]17b$_E>f;V1>M)QA;!-ao7l5ZNNZW5VrouN0Sj'Y4r<(I+7Q%+NCQ;-
-7mclM6?Qp?okOJJIouB1=nS[ros\/u_c8ZL$=WbJFJ+,Q00&MfXc=R7"G7%1<;@to
-Y3,=K<[lC<5?7B#C%dm.om^cNUH*JCD>*.1p@iM"#B9DM>\HKX=cSA^pG[3$gh/m,
-NYuk:Te_fn81u)8ip2Wh+a]R%B_KJ^G0b[4pON#,JaVuHpc!j#7tgY=L%o;8R73M%
-r`%qko97'@=ClRm3q%!>->lpcS(M2'SbHPnhI9,1Z%j'SkCIj_JpCF`q.H&i=V(:O
-RJEbLq6ujha.2tPc-P60Qa6:a_6GM%oS"15\IL+;19rZ1"GM7/Ri8`6IJrJ<,mbNK
-\1#OGO-b1=R!RAeqWG&C#G(`.Z25oSq_tkY7rG&ZJt3)kj5qAH-9uX#aZ1G($<@7.
-OkL-J;_j\IL.,9#r:4HCOF"sNHJcX<2oPRu`FXh3r--3ZLWKC[ao&%*T8Mj\jsF91
-It`/kgB/d-IuWkS!L62R;]YLjB'6/5hJ!(Dq*;iF8&bFnf_q_fIC;'3YMB*.h>QNn
-rV,40ROF^/=/PO-1&^ed5Z=I68q`=%k;VRf4bd;G+YPU,S/OY@?*pbq4q(fPrL_jD
-p[J1fn]n>rIlI!!8+cg_p&AT(F&8.d"r1S,NU#]PfT!)(C*OXZW(@K$hr3Zm;t"Mt'N5_L6u$N^5C+TXP'
+9HW6)(d\-A_8AR&]1DSi/MrYJiV"AP]GQ5!(]bTuiCXK"D?s\M&bOWce7K8"/OZ6X
+9;!A#1g*75!E.kY;RIf?1scj8AObU:+5p'\!JV5X1mo["=\cSne"+&jL-Plk'PAQj,^201l%iRAei
+rYts!+5qY\@K$quSOL=E=LHCUQ-i^ae0!WW7"If7_>Y9;,?8f**FZE3dihn[od\G$
+?GZU[1k$;#1*>I]%>"Kl!.RDD@9kb:?$7)oJHu?$rY&[s+5p`?1Q=Af[MQdZ*OM5A
+G!RTV;)[Br+5r@r@K%#bg)o9?$1u\@@0&di+(<`7@C3f]B0MOG(6dGiPbK.k
+T4Bj:.J+i[JUq%A&0Kk$5/AoXZtKU794h4?Ap/$"P[5Hj*!JY-'/gI;eD(m,+'Wm"
+BXZ/7&tj5[5Z^Sm]1_k"DRQTOFN7)J)?mR\#Qao@5lMka\OlM@E3bHh
+1NXAJrY;*N9[qE#TJ]0R.8na#DYGYT'fT4%bAnAn@_gl.p=F91:`\.ZFLOtdpJH&l
+ipRumlV0[?bHFL#&pT]'([,nWKXaa0pec7\'88DKKt(EBpgJn:AVPGD
+L:D)Tpi2'KFbb3eLU_bfpjmd9efKC$'>a97U&@p!liK-CIhs\dGb+rfliI4c&7@+4
+[3-QB)?iFp'qj,!6(/OUK8b&sN4@,kpsFd=63uO;NHj3;R,*c^iJr0?Nk"22f]eFk
+ooD*.Nu7hVGlNi8!K_R1OLYITq$E0$%?WXgOa.t0=Wrp<,E_dJP.<$)q'V@d/X'5MKf1)+o2cn6m$t&"sNCLi8>YBSe_(-T"46[q=1(:-^\%hT=KNFq>$[$rLc1X
+TR%'?=qRF=';51:Tt2,8qA5ke*MQ^\U3\Dc\hTqJ259q+UH1E1q(\LC@rtNZD'A"-
+_:0D)rZ%-(V4(J^\m_H.[M[O&Bjj13H-)sDTlUp^&@Nhr+@%%-,>DT]%\`k@<.:7O
+9F7CeWHt&5R[pH>TrNF2Wk,%,g8V+K[Au@!WuA[PHG?Ml_5qt%XLc2cTpj/r1>Y.El#qWG%CmB9^`YBp/N])f+)"g@e.YWE/qq[Kel$aG$jZ'uK5
+]-4HV-*c2RZ9'SBHS)Qc0sc3[Zb&*$gGuV:jeS#G1L[sl_3888GRu%u[MkCs2T60"l'(hoWu&3JT@7cag>&HiCdJXNY;8-*Wa>(iU.a$p6])b`;Ie/.Mjj"lHe\,,9rE%Q5?.N:iepVDd]lDVoFk6M8f/kA*d4u]XTHE-M&ldKj
+Q4=/UPM(>?7^TQrRWhDQO4]"1+81@0iM%&+=qF\-$^N/1+Wj>SQc\&@F#NY'!+4Df
+F%Ub@5o"=g4al0MHes0rhS&%-h::d+5on@r4FcNNAe>``k-R?@+W(A&J]Ls&7\5<:(!1(=RNLLI'"+uK;`?Fq
+oTq`FlFmAcrWh`FZg/[?lb9pqrjV5X^$K(AeU@l:2Fkd'YSQ)`l/%os^>\JYjlsTr
+%\?o3(?MHA&ec:M'gTPVr^ZH!8ammIE$:qj4\O;a#KkUhe9q("@=/W[rYBZ35N,-?
+^@!*%3!c-6o:IsH+I,eCDA@]DAN!W\SI9MTrY-*e&_>uW_(5g7s7CmA(j%ddW_5;e&A@;@jiX+m9j;e:$`a,_!HVP[AXqm`1)1b$q
+&,$&Nrj=c$ecrWP.MDbc*M;[4A,VpmJ$kT'pr()n!Ka^qe]m1u0kY)oM-WNFb[IE(Mm]3MNU>Ku$tID0(WGT6>a!JA9uE>VAM
+*uBdRA+A4lDGMF?a^oN2I+DL^REjsdg)UBY5GcbA[$lDDVcftMCA%GZL
+r>qS4YM&=;Hi>*/Qd=phqgJJdT@`Q-rVn:$l2#n%8$[T:SqgbS"@5jUhJf+L8MYd[
+Jsp#46Kr;AQ]OJ#r^)5bq%+(6!=VO5&MYh6',(E:ra-57q8R!HkLoEUT'(t0H(?>Y
+c=s25&X6"^js_N!8CAsdAeXCUG(6&0ZkRX)kJ?5/T81hnHC^u0TMqKE:qmYT^tJ]Q
+!g'cGQP9L3Le46%;6q45&0)&X^[oD84\p.[q`dmE.u?POF?=htKk"7dFerkXuu11HXBkJ"bU5cFsW&Mb,>'^C*2TKC4DX^oq,pO#PjHSTB1=GJ!/dGdr.S[Go.2A
+ah_(7+6AUAFBqsBf6:Msi<"LtKmEZ@S#Z;ZIEo+1Ed/R:q93Lok2C]L,Y8IUJ"+OT
+c=nB`M9@A@a3j=)T;UZII%H,h^g`qu4g'OaL\W&/>O^#g)^"0Yc=5&_m?;+R#G$jD
+B)0GfSNYLT7A"5("\58!qAt9`B_jWNU?QtnRAFW/L7bGZg8:XFl?'IYX_W7F]uW2BDJQ0V^'=_;2ST/q7WE^#b6C-Tu$^s"F3KM
+QP.-Vr`P7:ktll!Ed&tSo"#Ba8%b@ECj>CJ)s3"86h3h\RcdRH^Cf!HN(h(XF#9.
+];p;XkJ?V75:=MCHs]Ceo_e_jg\-'q?fKCY5H!iEIfII[rI9=[qu8nU!OO7B(t#Q!RMaFHR-;?$l/ff+MW4ZFf;?NT'-#`+TY,:k4tr1AX6M30D<7&Zdm
+@Z4*?;-#/8Gc)6If9!
+Znd^44qa86-P.Cl`/-0\+5$X[,=:X*NE#'\AX'NeLE\=nGe5S;jL^`knm+oAJM6."
+^6k)g@a$ikCaH1+R?KOA9_kA=AsCc5P?)HnH*K8>d^gHOE]prVC)mQSW!d[,Em?uN
+$4$He6n"%6:@p@c!.d$6KD\r/LgV`>N;FO>8WPq)#c^h7s$eE^IZO#B+6Wl-8SLmHMH">W;YjfqBpCKO
+Ph)=&H>u\oeN9[a0QITE&ON9%K2#>]%RK&O(Phe6'k@/iO+qI.aN1LmaES.n6=(u>
+kn+M(:7g#4^t1#8A#5HVQ.C9'=t;IEXd-&u(pCfQ.EQKHLYi#'c(
+Rj07F[H(neZaO+gfgn`W6$tJNXG21+VkiF:oTl^>p>6q&j`#!`_QGg-j'5fNE@t83
+\T]C_2-YQPDO&\^QWEEXHa.a3e_@^&FKrHI:bkGefNV6?o18c+,[:&/#35Y;30=m\
+OI?nQo7$R,X776@aJi[NI!6&)/qB6F(R%\4)./m"017%57*(4%XjK`UUlFQ/_;32C
+k9.8W[@=6QbqY*6Mt&i^A#C+iHW`N!LSk@$X`C3EE%&Ah_MNbGV!n;^dXQIRAah
+LQOC71EkP5OKFJ?,\3-YN-o]:DY>HsGc*T8I-mMHY'\J4o0$aAqjb#/K@$&'6YLl[
+U3'Fod?28ocp>`/>go!Z_eN6\_$)4g?>$;A\3khqB-;lk8&:2`^Z3h.-kh-`J-eLf
+,f*_'kG>J=\&.qJE3t`1P7&VqV@"HZ)mF&%JC"*/5AYb)Z8OV_fpaX-Co>%P[[,Cr
+RoaBBIBg5(f%\r73?1&g3\f`*mG*W(2`Lf0C[A39Sf'%*:4`\W\!#7?KD]]tVc*R#
+OQbQUi+WOlr\$YX'+1$kEUM3^!HJ.;adG"&%HfEccES3H#9E,XJ$*qn^"@Z"A*b4uT66aQg3Zn:
+m@C_qG5gIU:?'@0mePdE7QY=2a*[8UQ"H5CFs]NT3[OP^Tu!(RWAPcS>oT;Iho[Sk
+-KtIIU4e$H6;?D/>ukqh(_.)S,A9t5"`sD/\U>ftCHuopq#lqS->&I>>/h^8'G0
+IrXn)f=UdKpYTHC@Rp[ |
+ 
+